Commit3e8cf4e

Gauvain Pocentek

committed

Rewrite the README

And link to the docs on RTD.

1 parentca44878 commit3e8cf4eCopy full SHA for 3e8cf4e

File tree

+38

-170

lines changed

+38

-170

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-includeREADME.mdCOPYING AUTHORS ChangeLog requirements.txt test-requirements.txt`
	`1`	`+include COPYING AUTHORS ChangeLog requirements.txt test-requirements.txt`
`2`	`2`	`include tox.ini .testr.conf`
`3`	`3`	`recursive-include tools *`

Lines changed: 0 additions & 169 deletions

This file was deleted.

Lines changed: 37 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,37 @@`
	`1`	`+Python GitLab`
	`2`	`+=============`
	`3`	`+`
	`4`	+``python-gitlab`` is a Python package providing access to the GitLab server API.
	`5`	`+`
	`6`	+It supports the v3 api of GitLab, and provides a CLI tool (``gitlab``).
	`7`	`+`
	`8`	`+Installation`
	`9`	`+============`
	`10`	`+`
	`11`	`+Requirements`
	`12`	`+------------`
	`13`	`+`
	`14`	`+python-gitlab depends on:`
	`15`	`+`
	`16`	+* `python-requests<http://docs.python-requests.org/en/latest/>`_
	`17`	+* `six<https://pythonhosted.org/six/>`_
	`18`	`+`
	`19`	`+Install with pip`
	`20`	`+----------------`
	`21`	`+`
	`22`	`+..code-block::console`
	`23`	`+`
	`24`	`+ pip install python-gitlab`
	`25`	`+`
	`26`	`+Bug reports`
	`27`	`+===========`
	`28`	`+`
	`29`	`+Please report bugs and feature requests at`
	`30`	`+https://github.com/gpocentek/python-gitlab/issues.`
	`31`	`+`
	`32`	`+`
	`33`	`+Documentation`
	`34`	`+=============`
	`35`	`+`
	`36`	+The documentation for CLI and API is available on `readthedocs
	`37`	+<http://python-gitlab.readthedocs.org/en/stable/>`_.

Comments

(0)