Browse Source

better docs

Jaromil 5 years ago
parent
commit
4b542abc04
1 changed files with 19 additions and 19 deletions
  1. 19 19
      README.md

+ 19 - 19
README.md

@@ -1,24 +1,23 @@
1 1
 ```
2
- .----------------.  .----------------.  .----------------.  .----------------.  .----------------. 
3
-| .--------------. || .--------------. || .--------------. || .--------------. || .--------------. |
4
-| |   ________   | || | _____  _____ | || |   ______     | || |  _________   | || |  _______     | |
5
-| |  |  __   _|  | || ||_   _||_   _|| || |  |_   __ \   | || | |_   ___  |  | || | |_   __ \    | |
6
-| |  |_/  / /    | || |  | |    | |  | || |    | |__) |  | || |   | |_  \_|  | || |   | |__) |   | |
7
-| |     .'.' _   | || |  | '    ' |  | || |    |  ___/   | || |   |  _|  _   | || |   |  __ /    | |
8
-| |   _/ /__/ |  | || |   \ '--' /   | || |   _| |_      | || |  _| |___/ |  | || |  _| |  \ \_  | |
9
-| |  |________|  | || |    '.__.'    | || |  |_____|     | || | |_________|  | || | |____| |___| | |
10
-| |              | || |              | || |              | || |              | || |              | |
11
-| '--------------' || '--------------' || '--------------' || '--------------' || '--------------' |
12
- '----------------'  '----------------'  '----------------'  '----------------'  '----------------'
2
+ _  _  _  _  _
3
+(_)(_)(_)(_)(_)
4
+          _(_)_         _   _  _  _  _    _  _  _  _  _       _  _
5
+        _(_) (_)       (_) (_)(_)(_)(_)_ (_)(_)(_)(_)(_)_  _ (_)(_)
6
+      _(_)   (_)       (_) (_)        (_(_) _  _  _ (_)(_)(_)
7
+    _(_)     (_)       (_) (_)        (_(_)(_)(_)(_)(_)(_)
8
+ _ (_) _  _  (_)_  _  _(_)_(_) _  _  _(_(_)_  _  _  _  (_)
9
+(_)(_)(_)(_)(_)(_)(_)(_) (_(_)(_)(_)(_)   (_)(_)(_)(_) (_)
10
+                           (_)
11
+                           (_)
13 12
 ```
14 13
 
15 14
 **Z**sh **U**ltimate **P**rogrammer's **E**xtensions **R**efurbished - version 0.1
16 15
 
17 16
 # Introduction
18 17
 
19
-Zuper is a minimalist library of extensions for Zsh programming, that
20
-is for all those people out there using Zsh as a programming language
21
-or a scripting glue.
18
+Zuper is a minimalist library of extensions for Zsh programming,
19
+because believe it or not Zsh is so slick and powerful that it can be
20
+used as a programming language.
22 21
 
23 22
 # Features
24 23
 
@@ -44,13 +43,15 @@ program call `endgame` for a clean exit. Example test program:
44 43
 debug=1
45 44
 # switch on zuper's key/value load/save extension
46 45
 zkv=1
46
+# switch off zuper's consul kv get/set extension
47
+unset consul
47 48
 
48 49
 source zuper
49 50
 
50 51
 # declare a custom global variable
51 52
 vars+=(myvar)
52
-# assign a value to our global variable
53
-myvar=ok
53
+# assign a default value to our global variable
54
+myvar=${myvar:-ok}
54 55
 
55 56
 # declare a custom function to print it out
56 57
 testfun() {
@@ -79,7 +80,7 @@ mymap=(
79 80
 )
80 81
 
81 82
 # save the map into a file
82
-zkv.save mymap test.map 
83
+zkv.save mymap test.map
83 84
 
84 85
 # free the map
85 86
 mymap=()
@@ -93,7 +94,7 @@ for i in ${(k)mymap}; do
93 94
     print "$i \t ${mymap[$i]}"
94 95
 done
95 96
 
96
-# end the program (will call destructors)
97
+# end the program (call destructors)
97 98
 endgame
98 99
 ```
99 100
 
@@ -125,4 +126,3 @@ the GNU Public License for more details.
125 126
 You should have received a copy of the GNU Public License along with
126 127
 this source code; if not, write to: Free Software Foundation, Inc.,
127 128
 675 Mass Ave, Cambridge, MA 02139, USA.
128
-