From 3e8cf4e9ea59b97bb1703b9cee1c3a3d9e6c7c42 Mon Sep 17 00:00:00 2001
From: Gauvain Pocentek <gauvain.pocentek@objectif-libre.com>
Date: Sat, 9 Jan 2016 15:41:00 +0100
Subject: Rewrite the README

And link to the docs on RTD.
---
 README.rst | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.rst

(limited to 'README.rst')

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/>`_.
-- 
cgit v1.2.1