Kazunori Ninomiya avatar Kazunori Ninomiya committed ca89ce5

Add README.md

Comments (0)

Files changed (1)

+# grunt-ect
+
+## Getting Started
+
+install via npm
+
+    npm install npm install git+ssh://git@bitbucket.org:2no/grunt-ect.git
+
+and in your Gruntfile.js file:
+
+    grunt.loadNpmTasks('grunt-ect');
+
+## Usage
+
+    grunt.initConfig({
+      ect: {
+        top: {
+          options: {
+            root: 'test/ect',
+          },
+          src:  'page',
+          dest: 'test/page.html',
+          variables: {
+            title : 'Hello, world!',
+            id : 'main',
+            links: [
+              { name : 'Google', url : 'http://google.com/' },
+              { name : 'Facebook', url : 'http://facebook.com/' },
+              { name : 'Twitter', url : 'http://twitter.com/' }
+            ],
+            upperHelper : function (string) {
+              return string.toUpperCase();
+            }
+          }
+        },
+        ...
+      },
+      ...
+    });
+
+run with:
+
+    grunt ect
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.