Add examples [ci skip]

Author: bzon

README.md

@@ -7,13 +7,26 @@
 
 Be a rockstar and efficiently manage your team's gitlab.org or [self-hosted Gitlab](https://about.gitlab.com/installation/) projects, groups, users and other resources.
 
+Tested on __Gitlab 10.7.4__
+
 ## Getting Started
 
-Please see [Github site](https://devopsctl.github.io/gitlabctl/) for a nice documentation of this project.
+Please see [Commands Manual](https://devopsctl.github.io/gitlabctl/) for a nice documentation of this project.
 
 ## Installing
 
-Download the binary from [releases](https://github.com/devopsctl/gitlabctl/releases) or use Go Get, `go get github.com/devopsctl/gitlabctl`.
+Get the download link of your preferred platform binary from [RELEASES](https://github.com/devopsctl/gitlabctl/releases) and ensure that it is downloaded in one of your `$PATH` directories.
+
+```bash
+# This is an example manual installation
+wget https://github.com/devopsctl/gitlabctl/releases/download/v0.0.1/gitlabctl-darwin-amd64
+mv gitlabctl-darwin-amd64 /usr/local/bin/gitlabctl && chmod +x /usr/local/bin/gitlabctl
+
+# Test the command
+gitlabctl --version
+```
+
+For __Golang__ developers, you can get the latest binary using `go get github.com/devopsctl/gitlabctl`.
 
 Enable auto complete for __bash__ or __zsh__ shell. ❤️
 
@@ -22,6 +35,96 @@ Enable auto complete for __bash__ or __zsh__ shell. ❤️
 gitlabctl completion -h
 ```
 
+## Quickstart
+
+### Using the help commands
+
+```bash
+# get commands is used to list resources
+gitlabctl get [subcommand] -h
+
+# new commands is used to create a single resource
+gitlabctl new [subcommand] -h
+
+# edit commands is used to update a single resource
+gitlabctl edit [subcommand] -h
+
+# delete commands is used to delete a single resource
+gitlabctl delete [subcommand] -h
+
+# describe command is used to describe a single resource
+gitlabctl describe [subcommand]  -h
+```
+
+### Usage Examples
+
+Fetching resources with using `--output, -o` formatter flag.
+
+```bash
+>> gitlabctl get groups
++----+------------------+------------------------------------------------+-----------+
+| ID |       PATH       |                      URL                       | PARENT ID |
++----+------------------+------------------------------------------------+-----------+
+| 13 | Group1           | http://localhost:10080/groups/Group1           |         0 |
+| 14 | Group2           | http://localhost:10080/groups/Group2           |         0 |
+| 16 | Group1/SubGroup2 | http://localhost:10080/groups/Group1/SubGroup2 |        13 |
+| 15 | Group1/SubGroup1 | http://localhost:10080/groups/Group1/SubGroup1 |        13 |
+| 17 | Group2/SubGroup3 | http://localhost:10080/groups/Group2/SubGroup3 |        14 |
+| 18 | Group2/SubGroup4 | http://localhost:10080/groups/Group2/SubGroup4 |        14 |
++----+------------------+------------------------------------------------+-----------+
+```
+
+```bash
+>> gitlabctl get groups -o json
+[
+ {
+  "id": 13,
+  "name": "Group1",
+  "path": "Group1",
+  "description": "Updated by go test by id",
+  "visibility": "private",
+  "lfs_enabled": false,
+  "avatar_url": "",
+  "web_url": "http://localhost:10080/groups/Group1",
+  "request_access_enabled": false,
+  "full_name": "Group1",
+  "full_path": "Group1",
+  "parent_id": 0,
+  "projects": null,
+  "statistics": null
+ },
+ {
+  "id": 14,
+  "name": "Group2",
+  "path": "Group2",
+  "description": "",
+  "visibility": "private",
+  "lfs_enabled": true,
+  "avatar_url": "",
+  "web_url": "http://localhost:10080/groups/Group2",
+  "request_access_enabled": false,
+  "full_name": "Group2",
+  "full_path": "Group2",
+  "parent_id": 0,
+  "projects": null,
+  "statistics": null
+ },
+ ]
+```
+
+Creating resources.
+
+```bash
+# create a group
+>> gitlabctl new group devopsctl
+
+# create a project under devopsctl group
+>> gitlabctl new project gitlab-cli --namespace=devopsctl
+
+# create a new user with username john
+>> gitlabctl new user john --name="John Smith" --password="john123456" --email=john@example.com --reset-password 
+```
+
 ## Contributing
 
 Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for the process for submitting pull requests to us.