Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoyann committed Jul 15, 2017
1 parent 02abc43 commit d47d8cf
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,39 @@ If you prefer to place the configuration file in another place, you can use `-c,
./bin/deploy --config ./config/your_conf.js
```

## used with webpack plugin
## Used with plugins

each plugin can called like this:

```js
new DeployPlugin([config])
```

`config` is optional. if you omitted the `config`, Deploy-kit will automatic load the `deploy.js` from the `process.cwd()`.


* sftp-webpack-plugin



```js
const deployConfig = require('./deploy.js')
const DeployPlugin = require('deploy-kit/plugins/webpack-plugin')

// webpack configuration
moudle.exports = {
...
plugins: [
new DeployPlugin(deployConfig)
new DeployPlugin()
]
}
```
> todos:
* ftp-webpack-plugin
* sftp-gulp-plugin
* ftp-gulp-plugin
* sftp-fis-plugin

## How to write a plugin

> todo

0 comments on commit d47d8cf

Please sign in to comment.