Skip to content

Commit a4da15d

Browse files
committed
chore: convert README to markdown.
1 parent 97f1ece commit a4da15d

File tree

2 files changed

+24
-32
lines changed

2 files changed

+24
-32
lines changed

README.rst renamed to README.md

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,41 @@
1-
Vultr
2-
=====
3-
.. image:: https://travis-ci.org/spry-group/python-vultr.svg?branch=master
4-
:target: https://travis-ci.org/spry-group/python-vultr
1+
# Vultr
52

6-
Vultr provides a client library to the `Vultr.com <http://www.vultr.com/?ref=6989379-3B>` API.
3+
[![build status](https://travis-ci.org/spry-group/python-vultr.svg?branch=master)](https://travis-ci.org/spry-group/python-vultr)
74

8-
**Usage**
5+
Vultr provides a client library to the [Vultr.com](http://www.vultr.com/?ref=6989379-3B) API.
96

10-
.. code:: python
7+
## Usage
118

12-
api_key = 'XXXXXXXXX'
13-
vultr = Vultr(api_key)
14-
plans_json = vultr.plans.list()
9+
```python
10+
api_key = 'XXXXXXXXX'
11+
vultr = Vultr(api_key)
12+
plans_json = vultr.plans.list()
13+
```
1514

15+
## Testing
1616

17-
18-
**Testing**
19-
20-
From the repo root directory
21-
Performs generic, unauthenticated tests
22-
23-
.. code:: shell
17+
From the repo root directory
18+
Performs generic, unauthenticated tests
2419

25-
python -m unittest -v tests.test_vultr.UnauthenticatedTests
26-
20+
```shell
21+
python -m unittest -v tests.test_vultr.UnauthenticatedTests
22+
```
2723

2824
Requires the environment variable VULTR_KEY to be set
2925

30-
.. code:: shell
31-
32-
python -m unittest -v tests.test_vultr.AuthenticatedTests
33-
34-
35-
**Support**
26+
```shell
27+
python -m unittest -v tests.test_vultr.AuthenticatedTests
28+
```
3629

30+
## Support
3731

3832
Python Vultr is supported on a volunteer basis.
3933

40-
* `Open an Issue <https://github.com/spry-group/python-vultr/issues/new>`_
41-
42-
* .. image:: https://badges.gitter.im/Join%20Chat.svg
43-
:target: https://gitter.im/spry-group/python-vultr
44-
34+
* [Open an Issue](https://github.com/spry-group/python-vultr/issues/new)
35+
* [![Gitter.im](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/spry-group/python-vultr)
4536

46-
**API**
4737

38+
## API
4839

4940
* def account.info(self, params=None):
5041
* def app.list(self, params=None):

setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ def read(filename):
1818
"requests"
1919
],
2020
description='Vultr.com API Client',
21-
long_description=(read('README.rst')),
21+
long_description=(read('README.md')),
22+
long_description_content_type='text/markdown',
2223
url='http://github.com/spry-group/python-vultr',
2324
author='Darrel O\'Pry',
2425
author_email='[email protected]',

0 commit comments

Comments
 (0)