summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain.pocentek@objectif-libre.com>2016-01-09 15:41:00 +0100
committerGauvain Pocentek <gauvain.pocentek@objectif-libre.com>2016-01-09 15:42:19 +0100
commit3e8cf4e9ea59b97bb1703b9cee1c3a3d9e6c7c42 (patch)
tree92a0dd4ebfe0efcc026e373d4f78b0b6338b2caf /README.rst
parentca44878787a3e907ea35fd4adbb0a5c3020b44ed (diff)
downloadgitlab-3e8cf4e9ea59b97bb1703b9cee1c3a3d9e6c7c42.tar.gz
Rewrite the README0.11
And link to the docs on RTD.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..2fe702e
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,37 @@
+Python GitLab
+=============
+
+``python-gitlab`` is a Python package providing access to the GitLab server API.
+
+It supports the v3 api of GitLab, and provides a CLI tool (``gitlab``).
+
+Installation
+============
+
+Requirements
+------------
+
+python-gitlab depends on:
+
+* `python-requests <http://docs.python-requests.org/en/latest/>`_
+* `six <https://pythonhosted.org/six/>`_
+
+Install with pip
+----------------
+
+.. code-block:: console
+
+ pip install python-gitlab
+
+Bug reports
+===========
+
+Please report bugs and feature requests at
+https://github.com/gpocentek/python-gitlab/issues.
+
+
+Documentation
+=============
+
+The documentation for CLI and API is available on `readthedocs
+<http://python-gitlab.readthedocs.org/en/stable/>`_.