Add usage example to README.md

Author: LD250

README.md

@@ -8,7 +8,8 @@
 [python-jenkins](https://github.com/openstack/python-jenkins)
 
 # Tested on
-Jenkins ver: 1.565, 
+Jenkins ver: 1.565, 1.655
+
 Python ver: 2.7, 3.4, 3.5
 
 # Table of contents
@@ -19,9 +20,12 @@ Python ver: 2.7, 3.4, 3.5
 
 # Installation:
 
-## Using pip
+```bash
+pip isntall 
+```
 
-## Clone 
+or
+ 
 ```bash
 git clone https://github.com/LD250/jenkins-cli-python.git
 cd jenkins-cli-python
@@ -32,9 +36,14 @@ python setup.py install
 
 Server URL, Username and password may be specified either by the command line arguments or in configuration file **(.jenkins-cli)**. Command line arguments has the highest priority, after that the **.jenkins-cli** file from current folder is taking into account. If there is no.jenkins-cli file in current folder, settings will be read from **.jenkins-cli** from the home folder
 
-# Commands overwiew:
-```bash
-  {jobs,queue,building,start,info,set_branch,stop,console}
+**.jenkins-cli** example
+```txt
+host=http://localhost:8082/
+username=username
+password=******
+```
+
+# Commands overview:
     jobs                Show all jobs and their statuses
     queue               Shows builds queue
     building            Build executor status
@@ -45,13 +54,87 @@ Server URL, Username and password may be specified either by the command line ar
     console             Show console for the build
     builds             	Show builds for job
     changes            	Show build's changes
-```
+Run `jenkins --help` for detailed help. To see the optional parameters, run `--help` for the specific command. For example `jenkins jobs --help` will show job status description and optional arguments.
+
 
 # Usage example:
 
+Show status descriptions
+```bash
+$ jenkins jobs --help
+usage: jenkins jobs [-h] [-a] [-p]
+
+Status description:
+
+... -> Unknown
+F.. -> Failed
+D.. -> Disabled
+U.. -> Unstable
+D.. -> Disabled
+S.. -> Stable
+A.. -> Aborted
+.>> -> Build in progress
+
+optional arguments:
+  -h, --help  show this help message and exit
+  -a          Show only active jobs
+  -p          Show only jobs thats in build progress
+```
+Show jobs
+```bash
+$ jenkins jobs
+D.. hudson
+S.. jenkins-cli
+U>> new-project
+```
+Show job info
+```bash
+$ jenkins info jenkins-cli
+Last build name: jenkins-cli #18 (result: SUCCESS)
+Last success build name: jenkins-cli #18
+Build started: 2016-03-31 00:22:38.326999
+Building now: No
+Git branch set to: master
+```
+Update VCS branch
+```bash
+$ jenkins setbranch new-feature
+Done
+```
+Run job
+```bash
+$ jenkins start jenkins-cli
+jenkins-cli: started
+```
+Check job builds
+```bash
+$ jenkins builds jenkins-cli
+S.. #18 0:00:07 (2 commits)
+S.. #17 0:00:08 (2 commits)
+F.. #16 0:00:00 (4 commits)
+S.. #15 0:00:08 (2 commits)
+```
+Show previous build changes
+```bash
+$ jenkins changes jenkins-cli -b 17
+1. add .travis.yml from add-travis branch by Denys Levchenko affected 1 files 
+2. scaffolding for tests by Denys Levchenko affected 5 files 
+```
+Show current job console output (last 13 lines)
 ```bash
-jenkins [-h] [--host jenkins-url] [--username username] [--password password]
-         {jobs,queue,building,start,info,setbranch,stop,console} ...
+$ jenkins console jenkins-cli -n 13
+test_jobs (tests.test_cli.TestCliCommands) ... ok
+test_queue (tests.test_cli.TestCliCommands) ... ok
+test_set_branch (tests.test_cli.TestCliCommands) ... ok
+test_start (tests.test_cli.TestCliCommands) ... ok
+test_stop (tests.test_cli.TestCliCommands) ... ok
+test_read_settings_from_file (tests.test_cli.TestCliFileUsing) ... ok
+
+----------------------------------------------------------------------
+Ran 12 tests in 0.015s
+
+OK
+Finished: SUCCESS
 ```
 
 # Tests