Browse Source

change readme

bugtaker 5 years ago
parent
commit
6bc7a81301
1 changed files with 48 additions and 2 deletions
  1. 48 2
      README.md

+ 48 - 2
README.md

@@ -1,4 +1,50 @@
-Giter - Git users manager
-======
+Giter
+=====
 
 > Giter is a git users manager.
+
+
+## Install
+
+**Homebrew**
+```
+brew install jsmartx/giter/giter
+```
+
+**NPM**
+```
+npm install giter -g
+```
+
+**Snap**
+```
+snap install giter
+```
+
+## Usage
+
+```
+$ giter
+
+NAME:
+   giter - Git users manager
+
+USAGE:
+   giter [global options] command [command options] [arguments...]
+
+VERSION:
+   x.y.z
+
+COMMANDS:
+     list, ls  List all the git user config
+     use       Change git user config to username
+     show      Show git user detail
+     add, new  Add one custom user config
+     update    Update one custom user config
+     del, rm   Delete one custom user config
+     help, h   Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --help, -h     show help
+   --version, -v  print the version
+```