-
Notifications
You must be signed in to change notification settings - Fork 152
Closed
Description
Existing README.md (markdown) displays poorly on PyPI. Need to convert to reStructuredText.
Additionally, it would be good to revise the README's structure to cut strait to the point in demonstrating the value of the package:
- Use a narrative format to explain the value of the package.
- Native encapsulations of the API calls; with default parameters.
- Seamless and transparent support for processing pages of responses.
- Native encapsulation of the returned API objects; simple access to the data.
- Add simple examples showing doing useful things.
- Show an example of what these look like by comparison.
Proposed README structure:
- Package Introduction / Narrative
- Example(s)
- Installation
- Reporting Issues
- Contributing
- Releases