8000 more README updates · anby2015/python-gitlab@0922ed5 · GitHub
[go: up one dir, main page]

Skip to co 10000 ntent

Commit 0922ed5

Browse files
author
Gauvain Pocentek
committed
more README updates
1 parent f6abd4d commit 0922ed5

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,35 @@ It supports the v3 api of GitLab.
66

77
A CLI tool is also provided (called **gitlab**).
88

9-
## Requirements
9+
## Installation
10+
11+
### Requirements
1012

1113
python-gitlab depends on:
1214

13-
* [python-requests](http://docs.python-requests.org/en/latest/).
15+
* [python-requests](http://docs.python-requests.org/en/latest/)
16+
* [six](https://pythonhosted.org/six/)
17+
18+
### Install with pip
19+
20+
`````
21+
pip install python-gitlab
22+
`````
1423

1524
## State
1625

17-
python-gitlab >= 0.3 is considered stable.
26+
python-gitlab is considered stable.
1827

1928
## Bugs reports
2029

2130
Please report bugs and feature requests at
2231
https://github.com/gpocentek/python-gitlab/issues
2332

24-
## ToDo
33+
## Documentation
34+
35+
Work In Progress: http://python-gitlab.readthedocs.org/en/latest/
2536

26-
* Improve documentation
27-
* Write unit tests
37+
Patches are welcome!
2838

2939
## Code snippet
3040

docs/cli.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Commnad line use
2-
================
1+
Command line usage
2+
==================
33

44
Document here how to use command line tool

0 commit comments

Comments
 (0)
0