diff --git a/README b/README deleted file mode 100755 index e98f023..0000000 --- a/README +++ /dev/null @@ -1,37 +0,0 @@ -# Python Library for the KeyCDN API - - -## Installation - -``` bash -pip install keycdn -``` - -## Usage - -### Initial -```python -import keycdn - -... -api = keycdn.Api('') - -``` - -### Get all zones -```python -api.get('zones.json') -``` - -### Get a specific zone -```python -api.post('zones/.json') -``` - -### Purge zone cache -```python -api.get('zones/purge/.json') -``` - - -For more details visit https://www.keycdn.com diff --git a/README.md b/README.md index e98f023..d7f8358 100755 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # Python Library for the KeyCDN API - ## Installation -``` bash +```bash pip install keycdn ``` ## Usage ### Initial + ```python import keycdn @@ -19,19 +19,21 @@ api = keycdn.Api('') ``` ### Get all zones + ```python api.get('zones.json') ``` ### Get a specific zone + ```python api.post('zones/.json') ``` ### Purge zone cache + ```python api.get('zones/purge/.json') ``` - For more details visit https://www.keycdn.com diff --git a/setup.py b/setup.py index 5c8d7a6..08a8c62 100755 --- a/setup.py +++ b/setup.py @@ -1,10 +1,13 @@ import setuptools from distutils.core import setup + setup( name = 'keycdn', packages = ['keycdn'], version = '0.4', description = 'A Python REST Client for KeyCDN API', + long_description = open('README.md').read(), + long_description_content_type = 'text/markdown', author = 'KeyCDN', author_email = 'hello@keycdn.com', url = 'https://github.com/keycdn/python-keycdn-api',