Skip to content

Commit 3011484

Browse files
committed
Updated readme
1 parent d3efcb4 commit 3011484

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Laravel Elixir Icon fonts [![Version](https://img.shields.io/npm/v/laravel-elixir-fonts.svg?style=plastic)](https://www.npmjs.com/package/laravel-elixir-fonts) [![Dependences](https://img.shields.io/david/CodersAKL/laravel-elixir-fonts.svg?style=plastic)](https://www.npmjs.com/package/laravel-elixir-fonts) [![npm](https://img.shields.io/npm/l/laravel-elixir-fonts.svg?style=plastic)](https://www.npmjs.com/package/laravel-elixir-fonts) [![npm](https://img.shields.io/npm/dt/laravel-elixir-fonts.svg?style=plastic)](https://www.npmjs.com/package/laravel-elixir-fonts)
1+
# Laravel Elixir Icon fonts
22

33
This is a simple [gulp-iconfont](https://github.com/nfroidure/gulp-iconfont)
44
and [gulp-iconfont-css](https://github.com/backflip/gulp-iconfont-css) wrapper for [Laravel Elixir](https://github.com/laravel/elixir).
@@ -20,7 +20,7 @@ require('laravel-elixir-fonts');
2020

2121
elixir(function(mix) {
2222

23-
mix.fonts([elixir.config.assetsPath + '/svg/**/*.svg'], elixir.config.publicPath + '/fonts/');
23+
mix.fonts([elixir.config.assetsPath + '/svg/**/*.svg'], elixir.config.publicPath + '/fonts/', { font: { fontName: 'my_icons' } });
2424

2525
});
2626
```
@@ -36,6 +36,20 @@ These are the default paths, they can be overwritten by `elixir.config.assetsPat
3636

3737
## Options
3838

39-
> Wonders are coming...
40-
41-
39+
#### Default options
40+
```
41+
{
42+
font: {
43+
normalize: true,
44+
fontName: fontName, // required
45+
prependUnicode: false, // recommended option
46+
formats: ['ttf', 'eot', 'woff', 'woff2', 'svg'], // default, 'woff2' and 'svg' are available
47+
timestamp: runTimestamp // recommended to get consistent builds when watching files
48+
},
49+
css: {
50+
fontName: fontName,
51+
targetPath: '../../' + elixirConfig.assetsPath + '/' + elixirConfig.css.sass.folder + '/' + fontName + '.scss',
52+
fontPath: '../fonts/'
53+
}
54+
}
55+
```

0 commit comments

Comments
 (0)