Sparrow plugins documentation improvement (#75)

This commit is contained in:
Alexey Melezhik 2017-07-16 23:54:10 +03:00 committed by Alex Epstein
parent c4a73818dd
commit a83eab6f93
4 changed files with 24 additions and 17 deletions

View File

@ -1,7 +1,7 @@
{
"name" : "cloudup",
"description" : "Simple wrapper for cloudup script from Bash-Snippets",
"version" : "0.0.3",
"version" : "0.0.4",
"url" : "https://github.com/alexanderepstein/Bash-Snippets#cloudup",
"category": "utilities",
"sparrow_version" : "0.2.47",

View File

@ -12,6 +12,10 @@ Simple wrapper for `cloudup` script from Bash-Snippets.
Basic usage:
$ sparrow plg run cloudup -- <args>
For example:
$ sparrow plg run cloudup -- -p repo1 repo2 repo3
See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#cloudup](https://github.com/alexanderepstein/Bash-Snippets#cloudup)
@ -19,18 +23,19 @@ If you need some automation:
$ sparrow project create utils
$ sparrow task add utils $task-name cloudup
$ sparrow task add utils backup-top-repos cloudup
$ sparrow task ini utils/$task-name
$ sparrow task ini utils/backup-top-repos
---
args:
- foo
- bar
- so on ...
- '-p'
- repo1
- repo2
- repo3
$ sparrow task run utils/$task-name
$ sparrow task run utils/backup-top-repos
# Author

View File

@ -1,7 +1,7 @@
{
"name" : "stocks",
"description" : "Simple wrapper for stocks script from Bash-Snippets",
"version" : "0.0.3",
"version" : "0.0.4",
"url" : "https://github.com/alexanderepstein/Bash-Snippets#stocks",
"category": "utilities",
"sparrow_version" : "0.2.47",

View File

@ -12,27 +12,29 @@ Simple wrapper for `stocks` script from Bash-Snippets.
Basic usage:
$ sparrow plg run stocks -- <args>
For example:
See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#stocks](https://github.com/alexanderepstein/Bash-Snippets#stocks)
$ sparrow pl run stocks -- Google
If you need some automation:
Running via task:
$ sparrow project create utils
$ sparrow task add utils $task-name stocks
$ sparrow task add utils google-stocks stocks
$ sparrow task ini utils/$task-name
$ sparrow task ini utils/google-stocks
---
args:
- foo
- bar
- so on ...
- Google
$ sparrow task run utils/$task-name
$ sparrow task run utils/google-stocks
See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#stocks](https://github.com/alexanderepstein/Bash-Snippets#stocks)
# Author
# Authors
* The author of main script is [Alex Epstein](https://github.com/alexanderepstein)