Commit 91a8983f authored by Philipp Nowinski's avatar Philipp Nowinski
Browse files

[FEATURE] update README and release v3.2.0

parent bf1fc7e6
......@@ -85,16 +85,18 @@ Once the default tasks started and BrowserSync is ready to serve your files, all
* It will resolve css @import-statements to avoid additional requests.
* It will generate sourcempas for your css files.
* It will log the filesize of the generated css to the console. You can specify a limit to get warnings if this limit is exceeded.
* It will minify your css if you enabled this option during project generation.
* It will minify your css.
* javascript
*[command: 'gulp javascript']
* [command: 'gulp javascript']
* The javascript task runs jshint on your JS files. It also runs
[browserify](http://browserify.org/) on them. If you chose this option when
generating the setup, it will also minify them.
[browserify](http://browserify.org/) on them and uglify the result.
* images
* [command: 'gulp images']
* The images task will optimize (lossless) all images inside you images directory. This is not part of the watch
task, so you have to start it manually.
* [command: 'gulp images-fileadmin']
* Runs the image optimization on all images inside fileadmin and uploads. You might want to run this task on a regular
basis to compress user uploaded content.
* browser-sync
* [command: 'gulp browser-sync']
* BrowserSync starts a webserver with built-in code sync and action sync. Refer to
......@@ -110,6 +112,8 @@ The gulp-sgalinski generator will generate the following config files:
* .jshintrc
* This is where you can define all rules JsHint will apply to your code. If you delete this file, JsHint will use
the standard settings. This file should also work for instances of JsHint that are built into your Editor.
* .scss-lint.yml
* A configuration file for SCSS-Linters.
* gulp/config.json
* This is where the paths to your asset files, relative to the extension folder are defined, as well as the list
of extension names you want gulp to watch for changes.
......@@ -118,7 +122,7 @@ The gulp-sgalinski generator will generate the following config files:
file. This is where all used node modules (e.g. every gulp task is a node module) are defined as dependencies. They
will get installed from the NPM registry when you run 'npm install' inside your project root (the generator will run
'npm install' and 'bower install' automatically for you as its last step).
#### What to check in?
There are different opinions on which files should be under version control. We recommend to put the following files
on your ignorelist (.gitignore, .svnignore, etc.):
......@@ -130,6 +134,7 @@ on your ignorelist (.gitignore, .svnignore, etc.):
## Changelog
* 2015-07-21   v3.2.0   update to sprity; performance optim.; plugin updates; new config files
* 2015-06-04   v3.1.0   add inline-svg plugin
* 2015-05-21   v3.0.0   Remove standalone mode; get rid of asset-path.json; add check-filesize-plugin
* 2015-02-22   v2.1.0   add cache and scriptmerger deactivation via query string params
......
......@@ -51,3 +51,10 @@ Specifies the name of the generated file.
The plugin will generate an .scss-file by default, but you can easily adopt this for other languages, by using your own template. With this option, you can specify the path to a [mustache](https://github.com/janl/mustache.js/) template.
You can use the default template as a blueprint to create your own. And please don't hesitate to [share](http://gitlab.sgalinski.de/toolchain/gulp-inline-svg/fork/new) your template if you create one for an additional language.
### coloring
The template that comes with this generator offers you the option to overwrite fill colors that are set to #FFF. This can be useful if you are working with icons that appear in different colors throughout your project. To overwrite such a fill color, simply pass a HEX string as a second parameter to the mixin:
```scss
@include inline-svg($icon-name, '#000000');
```
# Included sprite-engine
This generator comes bundled with the [css-sprite](https://www.npmjs.com/package/css-sprite) engine.
This generator comes bundled with the [sprity](https://www.npmjs.com/package/sprity) engine.
## How it's set up
......@@ -21,4 +21,4 @@ The example above defines an .icon-class, which includes the icon-blue sprite (t
## Configuration
The _sprite.scss file is generated, based on a mustache template. You can find this template inside your gulp folder (gulp/sprite-scss-template.mustache).
\ No newline at end of file
The _sprite.scss file is generated, based on a mustache template. You can find this template inside your gulp folder (gulp/sprite-scss-template.mustache).
{
"name": "generator-gulp-sgalinski",
"version": "3.1.0",
"version": "3.2.0",
"description": "Yeoman generator",
"license": "MIT",
"main": "app/index.js",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment