Skip to content

Commit 6987e88

Browse files
committed
Add table of content to README.md
1 parent 0d81303 commit 6987e88

1 file changed

Lines changed: 35 additions & 9 deletions

File tree

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,32 @@
77
**Based on**
88
[python-jenkins](https://github.com/openstack/python-jenkins)
99

10-
# Install:
10+
# Tested on
11+
Jenkins ver: 1.565,
12+
Python ver: 2.7, 3.4, 3.5
13+
14+
# Table of contents
15+
* [Installation](#installation)
16+
* [Commands overwiew](#commands-overwiew)
17+
* [Usage example](#usage-example)
18+
* [Tests](#tests)
19+
20+
# Installation:
21+
22+
## Using pip
23+
24+
## Clone
1125
```bash
1226
git clone https://github.com/LD250/jenkins-cli-python.git
1327
cd jenkins-cli-python
1428
python setup.py install
1529
```
1630

17-
# Usage:
18-
19-
```bash
20-
jenkins [-h] [--host jenkins-url] [--username username] [--password password]
21-
{jobs,queue,building,start,info,setbranch,stop,console} ...
22-
```
31+
## Configuration file (.jencins-cli)
2332

2433
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
2534

26-
27-
# Available commands:
35+
# Commands overwiew:
2836
```bash
2937
{jobs,queue,building,start,info,set_branch,stop,console}
3038
jobs Show all jobs and their statuses
@@ -38,3 +46,21 @@ Server URL, Username and password may be specified either by the command line ar
3846
builds Show builds for job
3947
changes Show build's changes
4048
```
49+
50+
# Usage example:
51+
52+
```bash
53+
jenkins [-h] [--host jenkins-url] [--username username] [--password password]
54+
{jobs,queue,building,start,info,setbranch,stop,console} ...
55+
```
56+
57+
# Tests
58+
59+
To perfom flake8 checks and run tests similar to Travis
60+
61+
```bash
62+
pip install -r requirements.txt
63+
tox
64+
```
65+
66+

0 commit comments

Comments
 (0)