diff --git a/README.md b/README.md index 3ef4606..549db08 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,31 @@ # Python Status.io -A Python wrapper around the Status.io API. +Python package for [Status.io](https://status.io) [![Downloads](https://img.shields.io/pypi/v/statusio-python.svg)](https://pypi.python.org/pypi/statusio-python/) -## Introduction -This library provides a pure Python interface for the [Status.io API](http://docs.statusio.apiary.io/). It works with Python versions from 2.6+. +This library provides a pure Python interface for the [Status.io API](http://developers.status.io/). It works with Python versions from 2.6+. -[Status.io](https://status.io) provides hosted system status pages. -## Installing +## Installation -You can install statusio-python using:: $ pip install statusio-python -## Documentation +## Usage -View the last release API documentation at: http://developers.status.io/ +```python +import statusio +api = statusio.Api(api_id='api_id', api_key='api_key') +``` -## Using -The library provides a Python wrapper around the Status.io API. +Retrieve status page summary: -### API +```python +summary = api.StatusSummary('status_page_id') +print(summary) +``` -The API is exposed via the `statusio.Api` class. - -To create an instance of the `statusio.Api` with yout credentials: - - >>> import statusio - >>> api = statusio.Api(api_id='api_id', - api_key='api_key') - -To retrieve your status page summary: - - >>> summary = api.StatusSummary('status_page_id') - >>> print(summary) - -View the full API documentation:: - - $ pydoc statusio.Api \ No newline at end of file +View the full API documentation at: http://developers.status.io/