update readme

Author: Zhe Feng

Gruntfile.js

@@ -31,10 +31,12 @@
     // Configuration to be run (and then tested).
     deploy: {
       liveservers: {
-        servers: require('servers').servers(),
-        cmds_before_deploy: [],
-        cmds_after_deploy: [],
-        deploy_path: '~/grunt-plugins/grunt-deploy'
+        options:{
+          servers: require('servers').servers(),
+          cmds_before_deploy: [],
+          cmds_after_deploy: [],
+          deploy_path: '~/grunt-plugins/grunt-deploy'
+        }
       }
       /*default_options: {
         options: {

README.md

@@ -1,6 +1,9 @@
-# grunt-deploy  deploy your node app easily
+# grunt-deploy: deploy your node app easily
 
-> The Grunt plugin to deploy nodejs app into ubuntu
+> The Grunt plugin to deploy node app into ubuntu
+
+Find more in [here](http://zhefeng.github.io/grunt-deploy/ "grunt-deploy").
+Google group in [here](https://groups.google.com/forum/?fromgroups#!forum/grunt-deploy "grunt-deploy group").
 
 ## Getting Started
 This plugin requires Grunt `~0.4.1`
@@ -25,62 +28,23 @@ In your project's Gruntfile, add a section named `deploy` to the data object pas
 ```js
 grunt.initConfig({
   deploy: {
-    options: {
-      // Task-specific options go here.
-    },
-    your_target: {
-      // Target-specific file lists and/or options go here.
-    },
-  },
-})
-```
-
-### Options
-
-#### options.separator
-Type: `String`
-Default value: `',  '`
-
-A string value that is used to do something with whatever.
-
-#### options.punctuation
-Type: `String`
-Default value: `'.'`
-
-A string value that is used to do something else with whatever else.
-
-### Usage Examples
-
-#### Default Options
-In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`
-
-```js
-grunt.initConfig({
-  deploy: {
-    options: {},
-    files: {
-      'dest/default_options': ['src/testing', 'src/123'],
-    },
+    liveservers: {
+      options:{
+        servers: [{
+          host: '123.123.123.12',
+          port: 22,
+          username: 'username',
+          password: 'password'
+        }],
+        cmds_before_deploy: ["some cmds you may want to exec before deploy"],
+        cmds_after_deploy: ["forever restart", "some other cmds you want to exec after deploy"],
+        deploy_path: 'your deploy path in server'
+      }
+    }
   },
 })
 ```
 
-#### Custom Options
-In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`
-
-```js
-grunt.initConfig({
-  deploy: {
-    options: {
-      separator: ': ',
-      punctuation: ' !!!',
-    },
-    files: {
-      'dest/default_options': ['src/testing', 'src/123'],
-    },
-  },
-})
-```
 
 ## Contributing
 In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

tasks/deploy.js

@@ -53,13 +53,13 @@
       }
 
       console.log('executing cmds before deploy');
-      execCmds(self.data.cmds_before_deploy, 0, function(){
+      execCmds(options.cmds_before_deploy, 0, function(){
         console.log('cmds before deploy executed');
 
 
-        var createFolder = 'cd ' + self.data.deploy_path + '/releases && mkdir ' + timeStamp;
-        var removeCurrent = 'rm -rf ' + self.data.deploy_path + '/current';
-        var setCurrent = 'ln -s ' + self.data.deploy_path + '/releases/' + timeStamp + ' ' + self.data.deploy_path + '/current';
+        var createFolder = 'cd ' + options.deploy_path + '/releases && mkdir ' + timeStamp;
+        var removeCurrent = 'rm -rf ' + options.deploy_path + '/current';
+        var setCurrent = 'ln -s ' + options.deploy_path + '/releases/' + timeStamp + ' ' + options.deploy_path + '/current';
 
         console.log('start deploy');
         exec(createFolder + ' && ' + removeCurrent + ' && ' + setCurrent,function(){
@@ -68,11 +68,11 @@
           var execLocal = require('child_process').exec;
           var child;
 
-          child = execLocal("scp -r . " + server.username + "@" + server.host + ":" + self.data.deploy_path + "/releases/" + timeStamp, function (error, stdout, stderr) {
+          child = execLocal("scp -r . " + server.username + "@" + server.host + ":" + options.deploy_path + "/releases/" + timeStamp, function (error, stdout, stderr) {
             console.log('end deploy');
 
             console.log('executing cmds after deploy');
-            execCmds(self.data.cmds_after_deploy, 0, function(){
+            execCmds(options.cmds_after_deploy, 0, function(){
               console.log('cmds after deploy executed');
               connection.end();
             });
@@ -81,7 +81,7 @@
       })
     }
 
-    var length = self.data.servers.length;
+    var length = options.servers.length;
     var completed = 0;
     var checkCompleted = function(){
       completed++;
@@ -90,7 +90,7 @@
       }
     }
 
-    self.data.servers.forEach(function(server){
+    options.servers.forEach(function(server){
       var c = new Connection();
       c.on('connect', function() {
         console.log('Connecting to server: ' + server.host);