Skip to content

Commit

Permalink
add example cases
Browse files Browse the repository at this point in the history
  • Loading branch information
tunnckoCore committed Jan 28, 2015
1 parent eb2d2d1 commit 9f0ce93
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions readme.md
Expand Up @@ -19,6 +19,44 @@ var gitclone = require('gitclone');

## API / CLI

```js
gitclone('tunnckoCore/async-exec-cmd', {ssh: true, dest: '../async-exec-cmd/'})
// gitclone('tunnckoCore/async-exec-cmd', function cb() {})
// gitclone('tunnckoCore/async-exec-cmd#v0.0.1', 'release/v0.0.1')
// gitclone('tunnckoCore/async-exec-cmd#v0.0.2', 'release/v0.0.2')
// gitclone('tunnckoCore/async-exec-cmd#v1.0.0', 'release/v1.0.0')
// gitclone('tunnckoCore/npmls', 'dest/to/path2', 'ssh[true/false]')
// gitclone('tunnckoCore/npmls', 'dest/to/path3', {stdio: 'inherit1'})
// gitclone('tunnckoCore/npmls', {stdio: 'inherit2'}, true)
// gitclone('tunnckoCore/npmls', {stdio: 'inherit3', ssh: true}, false)
// gitclone({
// user: 'tunnckoCore',
// repo: 'glob2fp',
// branch: 'yeah',
// dest: 'dest/to/path4',
// ssh: true,
// stdio: 'inherit4',
// })
// gitclone({
// user: 'tunnckoCore',
// repo: 'glob2fp',
// branch: 'yeah',
// options: {
// dest: 'dest/to/path5',
// ssh: true,
// stdio: 'inherit4'
// }
// })
// gitclone({
// user: 'tunnckoCore',
// repo: 'glob2fp',
// branch: 'feature',
// }, 'dest/to/path6', {
// ssh: false,
// stdio: 'falsefalsefalse'
// })
```


## Author
**Charlike Mike Reagent**
Expand Down

0 comments on commit 9f0ce93

Please sign in to comment.