summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain.pocentek@objectif-libre.com>2015-06-17 20:56:55 +0200
committerGauvain Pocentek <gauvain.pocentek@objectif-libre.com>2015-06-17 20:56:55 +0200
commit0922ed5453aaa5e982012bab16d9517e28626977 (patch)
tree8dfb478201e1b895b3cb9af229e31ea7935dd438 /README.md
parentf6abd4da5fc8958795995e892cc42be1bd352bea (diff)
downloadgitlab-0922ed5453aaa5e982012bab16d9517e28626977.tar.gz
more README updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index 14fc6a1..8196a30 100644
--- a/README.md
+++ b/README.md
@@ -6,25 +6,35 @@ It supports the v3 api of GitLab.
A CLI tool is also provided (called **gitlab**).
-## Requirements
+## Installation
+
+### Requirements
python-gitlab depends on:
-* [python-requests](http://docs.python-requests.org/en/latest/).
+* [python-requests](http://docs.python-requests.org/en/latest/)
+* [six](https://pythonhosted.org/six/)
+
+### Install with pip
+
+`````
+pip install python-gitlab
+`````
## State
-python-gitlab >= 0.3 is considered stable.
+python-gitlab is considered stable.
## Bugs reports
Please report bugs and feature requests at
https://github.com/gpocentek/python-gitlab/issues
-## ToDo
+## Documentation
+
+Work In Progress: http://python-gitlab.readthedocs.org/en/latest/
-* Improve documentation
-* Write unit tests
+Patches are welcome!
## Code snippet