updated readme

Sterc · Jan 8, 2016 · 5d721db · 5d721db
1 parent 3aee0d4
commit 5d721db
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # Modx Minify
 
+Modx Minify is a MODX CMP to group and minify your CSS, SCSS, LESS and JS files. You can create groups, and each group can contain multiple files of the same type. So for instance you create a group named 'css' where you can add all your css or scss files. After that you put the snippet call [[!modxMinify?&group=`css`]] inside a 'link' tag in your head and a minified css file will be generated which will contain all your files grouped and minified!
+
 ## Usage
-1. Clone the project (or download zip and unpack) to your website root folder.
-2. Edit the config.json file and add your css, scss or js files inside the 'groups' key.
-3. In MODX, create a snippet, make it static, and point the static filename to /modx/minifygetfilename.snippet.php
-4. In your <head> in your template, place the snippet call, eg: [[!minifyGetFilename?&groups=`css`]]
+1. Install the package via Package Management
+2. Add groups and files via the cmp
+4. In your <head> in your template, place the snippet call, eg: [[!modxMinify?&group=`css`]]