RC1 - documentation

README.md

@@ -1,2 +1,52 @@
 # css-compiler
 compiles SASS/LESS and Compass, available though Composer
+
+
+# How to use:
+add into composer __scripts__ directory:
+```
+"EM\\CssCompiler\\Handler\\ScriptHandler::compileCSS"
+```
+
+example: 
+```
+    "scripts": {
+        "post-update-cmd": "@custom-events",
+        "post-install-cmd": "@custom-events",
+        "custom-events": [
+            "EM\\CssCompiler\\Handler\\ScriptHandler::compileCSS"
+        ]
+    },
+```
+
+##how to trigger
+add _css-compiler_ information inside of the _extra_ composer configuration
+```
+    "css-compiler": [
+        {
+            "format": "compact",
+            "input": [
+                "tests/shared-fixtures/scss"
+            ],
+            "output": "var/cache/assets/scss.css"
+        },
+        {
+            "format": "compact",
+            "input": [
+                "tests/shared-fixtures/sass"
+            ],
+            "output": "var/cache/assets/sass.css"
+        },
+        {
+            "format": "compact",
+            "input": [
+                "tests/shared-fixtures/compass/app.scss"
+            ],
+            "output": "var/cache/assets/compass.css"
+        }
+    ]
+```
+where:
+    _format_: compression format
+    _input_: array of routes, all files inside of the route if it is directory will be picked up
+    _output_: file where it should put content (hard-copy)

phpunit.xml

@@ -13,19 +13,16 @@
          syntaxCheck                 = "false"
          bootstrap                   = "vendor/autoload.php"
 >
-    <php>
-        <server name="KERNEL_DIR" value="app/" />
-    </php>
 
     <testsuites>
         <testsuite name="mandatory test suite">
-            <directory>./tests</directory>
+            <directory>tests/</directory>
         </testsuite>
     </testsuites>
 
     <filter>
         <whitelist>
-            <directory>./src</directory>
+            <directory>src/</directory>
         </whitelist>
     </filter>
 </phpunit>