Update README.md

rvtraveller · Jan 26, 2017 · fc9946f · fc9946f
1 parent 46ec66a
commit fc9946f
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,18 @@
 # Quicksilver Composer Installer #
 
-Creates a new "type" in Composer for `quicksilver-modules` so you can treat them separately in Composer installations.
+Creates a new "type" in Composer for `quicksilver-modules` so you can treat them separately in Composer installations.  This allows you to include Quicksilver scripts as part of a composer based project on Pantheon[https://pantheon.io].
+
+## Example composer.json file ##
+
+```
+{
+  "require": {
+    "rvtraveller/qs-revert-all-features-d7": "1.0"
+  },
+  "extra": {
+    "installer-paths": {
+      "web/private/scripts/quicksilver/{$name}": ["type:quicksilver-module"]
+    }
+  }
+}
+```