Update Sparrow plugins documentation, added examples of how to run (part2) (#78)

2017-07-17 20:42:32 +03:00 · 2017-07-17 20:42:32 +03:00 · 8189ddc335
parent f51046e671
commit 8189ddc335
23 changed files with 134 additions and 115 deletions
--- a/cheat/sparrow.json
+++ b/cheat/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "cheat",
  "description" : "Simple wrapper for cheat script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#cheat",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/cheat/sparrow.md
+++ b/cheat/sparrow.md
@ -13,26 +13,30 @@ Basic usage:

    $ sparrow plg run cheat -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#cheat](https://github.com/alexanderepstein/Bash-Snippets#cheat)
+For example:

-If you need some automation:
+    $ sparrow plg run cheat -- -i Perl
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name cheat
+    $ sparrow task add utils cheat-perl cheat

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/cheat-perl

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - '-i'
+        - Perl
+        - lwp-request

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/cheat-perl

-# Author
+For cheat's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#cheat](https://github.com/alexanderepstein/Bash-Snippets#cheat)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/cloudup/sparrow.md
+++ b/cloudup/sparrow.md
@ -17,8 +17,6 @@ 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)
-
 If you need some automation:

    $ sparrow project create utils
@ -37,7 +35,9 @@ If you need some automation:

    $ sparrow task run utils/backup-top-repos

-# Author
+See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#cloudup](https://github.com/alexanderepstein/Bash-Snippets#cloudup)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/crypt/sparrow.json
+++ b/crypt/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "crypt",
  "description" : "Simple wrapper for crypt script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#crypt",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/crypt/sparrow.md
+++ b/crypt/sparrow.md
@ -13,26 +13,26 @@ Basic usage:

    $ sparrow plg run crypt -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#crypt](https://github.com/alexanderepstein/Bash-Snippets#crypt)
-
-If you need some automation:
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name crypt
+    $ sparrow task add utils enc-file crypt

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/enc-file

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - '-e'
+        - /tmp/file.txt
+        - /tmp/file.txt.inc

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/enc-file

-# Author
+For crypt's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#cheat](https://github.com/alexanderepstein/Bash-Snippets#crypt)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/currency/sparrow.json
+++ b/currency/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "currency",
  "description" : "Simple wrapper for currency script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#currency",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/currency/sparrow.md
+++ b/currency/sparrow.md
@ -13,26 +13,30 @@ Basic usage:

    $ sparrow plg run currency -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#currency](https://github.com/alexanderepstein/Bash-Snippets#currency)
+For example:

-If you need some automation:
+    $ sparrow plg run currency -- USD RUB 100
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name currency
+    $ sparrow task add utils currency-usd-rub currency

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/currency-usd-rub

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - USD
+        - RUB
+        - 100

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/currency-usd-rub

-# Author
+For currency's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#currency](https://github.com/alexanderepstein/Bash-Snippets#currency)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/geo/sparrow.json
+++ b/geo/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "geo",
  "description" : "Simple wrapper for geo script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#geo",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/geo/sparrow.md
+++ b/geo/sparrow.md
@ -13,30 +13,31 @@ Basic usage:

    $ sparrow plg run geo -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#geo](https://github.com/alexanderepstein/Bash-Snippets#geo)
+For example:

-If you need some automation:
+    $ sparrow plg run geo -- -r -d -m eth0
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name geo
+    $ sparrow task add utils geo-data geo

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/geo-data

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - '-r'
+        - '-d'
+        - '~m' : eth0

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/geo-data

-# Author
+For geo's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#geo](https://github.com/alexanderepstein/Bash-Snippets#geo)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

 * The plugin maintainer is [Alexey Melezhik](https://github.com/melezhik/)
-
-
-
--- a/movies/sparrow.json
+++ b/movies/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "movies",
  "description" : "Simple wrapper for movies script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#movies",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/movies/sparrow.md
+++ b/movies/sparrow.md
@ -13,26 +13,28 @@ Basic usage:

    $ sparrow plg run movies -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#movies](https://github.com/alexanderepstein/Bash-Snippets#movies)
+For example:

-If you need some automation:
+    $ sparrow plg run movies -- Argo
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name movies
+    $ sparrow task add utils movies-argo movies

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/movies-argo

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - Argo

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/movies-argo

-# Author
+For movies's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#movies](https://github.com/alexanderepstein/Bash-Snippets#movies)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/qrify/sparrow.json
+++ b/qrify/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "qrify",
  "description" : "Simple wrapper for qrify script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#qrify",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/qrify/sparrow.md
+++ b/qrify/sparrow.md
@ -13,26 +13,28 @@ Basic usage:

    $ sparrow plg run qrify -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#qrify](https://github.com/alexanderepstein/Bash-Snippets#qrify)
+For example:

-If you need some automation:
+    $ sparrow plg run qrify -- hello world
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name qrify
+    $ sparrow task add utils qrify-text qrify

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/qrify-text

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - Hello world

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/qrify-text

-# Author
+For qrify's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#qrify](https://github.com/alexanderepstein/Bash-Snippets#qrify)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/short/sparrow.json
+++ b/short/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "short",
  "description" : "Simple wrapper for short script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#short",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/short/sparrow.md
+++ b/short/sparrow.md
@ -13,26 +13,28 @@ Basic usage:

    $ sparrow plg run short -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#short](https://github.com/alexanderepstein/Bash-Snippets#short)
+For example:

-If you need some automation:
+    $ sparrow plg run short -- tinyurl.com/jhkj
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name short
+    $ sparrow task add utils short-unmusk-jhkj short

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/short-unmusk-jhkj

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - tinyurl.com/jhkj

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/short-unmusk-jhkj

-# Author
+For short's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#short](https://github.com/alexanderepstein/Bash-Snippets#short)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/stocks/sparrow.json
+++ b/stocks/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "stocks",
  "description" : "Simple wrapper for stocks script from Bash-Snippets",
-  "version" : "0.0.4",
+  "version" : "0.0.5",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#stocks",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/stocks/sparrow.md
+++ b/stocks/sparrow.md
@ -2,7 +2,6 @@

 Simple wrapper for `stocks` script from Bash-Snippets.

-
 # INSTALL

    $ sparrow plg install stocks
@ -17,7 +16,7 @@ For example:

    $ sparrow pl run stocks -- Google

-Running via task:
+Run as sparrow task:

    $ sparrow project create utils

@ -31,14 +30,11 @@ Running via task:
        - Google

    $ sparrow task run utils/google-stocks
-    
-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#stocks](https://github.com/alexanderepstein/Bash-Snippets#stocks)

+For stocks's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#stocks](https://github.com/alexanderepstein/Bash-Snippets#stocks)
+    
 # Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

 * The plugin maintainer is [Alexey Melezhik](https://github.com/melezhik/)
-
-
-
--- a/taste/sparrow.json
+++ b/taste/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "taste",
  "description" : "Simple wrapper for taste script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#taste",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/taste/sparrow.md
+++ b/taste/sparrow.md
@ -13,26 +13,29 @@ Basic usage:

    $ sparrow plg run taste -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#taste](https://github.com/alexanderepstein/Bash-Snippets#taste)
+For example:

-If you need some automation:
+    $ sparrow plg run taste -- -s Red Hot Chili Peppers
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name taste
+    $ sparrow task add utils taste-rhcp taste

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/taste-rhcp

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - '-s'
+        - Red Hot Chili Peppers

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/taste-rchp

-# Author
+For taste's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#taste](https://github.com/alexanderepstein/Bash-Snippets#taste)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/weather/sparrow.json
+++ b/weather/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "weather",
  "description" : "Simple wrapper for weather script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#weather",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/weather/sparrow.md
+++ b/weather/sparrow.md
@ -13,26 +13,28 @@ Basic usage:

    $ sparrow plg run weather -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#weather](https://github.com/alexanderepstein/Bash-Snippets#weather)
+For example:

-If you need some automation:
+    $ sparrow plg run weather -- Saint-Petersburg
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name weather
+    $ sparrow task add utils weather-spb weather

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/weather-spb

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - Saint-Petersburg

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/weather-spb

-# Author
+For weather's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#weather](https://github.com/alexanderepstein/Bash-Snippets#weather)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)

--- a/ytview/sparrow.json
+++ b/ytview/sparrow.json
@ -1,7 +1,7 @@
 {
  "name" : "ytview",
  "description" : "Simple wrapper for ytview script from Bash-Snippets",
-  "version" : "0.0.3",
+  "version" : "0.0.4",
  "url" : "https://github.com/alexanderepstein/Bash-Snippets#ytview",
  "category": "utilities",
  "sparrow_version" : "0.2.47",
--- a/ytview/sparrow.md
+++ b/ytview/sparrow.md
@ -13,26 +13,29 @@ Basic usage:

    $ sparrow plg run ytview -- <args>

-See parameters description at [https://github.com/alexanderepstein/Bash-Snippets#ytview](https://github.com/alexanderepstein/Bash-Snippets#ytview)
+For example:

-If you need some automation:
+    $ sparrow plg run ytview -- -s Family Guy Chicken Fight
+
+Run as sparrow task:

    $ sparrow project create utils

-    $ sparrow task add utils $task-name ytview
+    $ sparrow task add utils ytview-fg ytview

-    $ sparrow task ini utils/$task-name
+    $ sparrow task ini utils/ytview-fg

      ---

      args:
-        - foo
-        - bar
-        - so on ...
+        - '-s'
+        - Family Guy Chicken Fight

-    $ sparrow task run utils/$task-name
+    $ sparrow task run utils/ytview-fg

-# Author
+For ytview's arguments description follow [https://github.com/alexanderepstein/Bash-Snippets#ytview](https://github.com/alexanderepstein/Bash-Snippets#ytview)
+
+# Authors

 * The author of main script is [Alex Epstein](https://github.com/alexanderepstein)