Repository navigation
Commit 0922ed5
Gauvain Pocentek
more README updates
1 parent f6abd4d commit 0922ed5
2 files changed
Lines changed: 18 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6,25 +6,35 @@ It supports the v3 api of GitLab. | |||
| 6 | 6 | ||
| 7 | 7 | A CLI tool is also provided (called **gitlab**). | |
| 8 | 8 | ||
| 9 | - ## Requirements | ||
| 9 | + ## Installation | ||
| 10 | + | ||
| 11 | + ### Requirements | ||
| 10 | 12 | ||
| 11 | 13 | python-gitlab depends on: | |
| 12 | 14 | ||
| 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 | + ````` | ||
| 14 | 23 | ||
| 15 | 24 | ## State | |
| 16 | 25 | ||
| 17 | - python-gitlab >= 0.3 is considered stable. | ||
| 26 | + python-gitlab is considered stable. | ||
| 18 | 27 | ||
| 19 | 28 | ## Bugs reports | |
| 20 | 29 | ||
| 21 | 30 | Please report bugs and feature requests at | |
| 22 | 31 | https://github.com/gpocentek/python-gitlab/issues | |
| 23 | 32 | ||
| 24 | - ## ToDo | ||
| 33 | + ## Documentation | ||
| 34 | + | ||
| 35 | + Work In Progress: http://python-gitlab.readthedocs.org/en/latest/ | ||
| 25 | 36 | ||
| 26 | - * Improve documentation | ||
| 27 | - * Write unit tests | ||
| 37 | + Patches are welcome! | ||
| 28 | 38 | ||
| 29 | 39 | ## Code snippet | |
| 30 | 40 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,4 +1,4 @@ | |||
| 1 | - Commnad line use | ||
| 2 | - ================ | ||
| 1 | + Command line usage | ||
| 2 | + ================== | ||
| 3 | 3 | ||
| 4 | 4 | Document here how to use command line tool | |
0 commit comments