README.md in jekyll-assets-2.0.0 vs README.md in jekyll-assets-2.0.1

- old
+ new

@@ -11,10 +11,14 @@ Jekyll 3 assets is an asset pipeline using Sprockets 3 to build especially for Jekyll 3. It utilizes new features of both Sprockets and Jekyll to achieve a clean and extensible assets platform for Jekyll. +## Having trouble with our documentation? + +If you do not understand something in our documentation please feel free to file a ticket and it will be explained and the documentation updated, however... if you have already figured out the problem please feel free to submit a pull request with clarification in the documentation and we'll happily work with you on updating it. + ## Using Jekyll Assets with Jekyll When you are using a Gemfile and bundler you need to do nothing special to get Jekyll Assets to work, it will automatically load itself and work with Jekyll when you bundle install and run Jekyll through bundle exec. However, when you @@ -26,10 +30,12 @@ - jekyll-assets ``` ## Configuration +A lot of our configuration transforms based on the `JEKYLL_ENV` variable set in your environment. Such as digesting and whether or not to enable the CDN. Some of them can be explictly overriden but a few cannot right now. You should set your `JEKYLL_ENV=development` on your development machine and `JEKYLL_ENV=production` when building to push. + ```yaml assets: compress: css: false | true | default - development: false, production: true js: false | true | default - development: false, production: true @@ -49,9 +55,13 @@ - _assets/stylesheets - _assets/fonts - _assets/img - _assets/js ``` + +### Sources + +The listed resources in the example are all defaults. It should be noted that we append your sources instead of replace our resources with yours. So if you add "_assets/folder" then we will append that to our sources and both will work. ### Digesting * Disable digesting by default in development. * Digest by default in production