Merge 2b17077 into 43a4c09

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## :tada: Welcome!
+
+Thank you for looking into how to contribute to this project. Bugs, feature requests and fixes are all dealt with using [GitHub issues](https://github.com/jemrobinson/octopusapi/issues). Don't worry if you feel that you don't understand something fully - create an issue or pull request anyway. We appreciate any sort of contribution and the worst that can happen is that you might be asked to change something.
+
+Before contributing, we encourage you to read our CONTRIBUTING policy (you are here), our [LICENSE](LICENSE), and our [README](README.md).
+
+Note that all contributions to the project will be released under the existing licence.

README.md

@@ -1,8 +1,42 @@
-# Python interface to the Octopus Energy API
+![OctopusAPI Logo](docs/_static/logo.png)
 
 [![Coverage Status](https://coveralls.io/repos/github/jemrobinson/octopusapi/badge.svg?branch=main)](https://coveralls.io/github/jemrobinson/octopusapi?branch=main)
+[![Dependabot](https://flat.badgen.net/dependabot/jemrobinson/octopusapi?icon=dependabot)](https://dependabot.com/)
+[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Licence: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
 
 [![Build Status](https://travis-ci.com/jemrobinson/octopusapi.svg?branch=main)](https://travis-ci.com/jemrobinson/octopusapi)
-![OSX](https://img.shields.io/badge/-555?&logo=apple&logoColor=white)[![Build Status](https://badges.herokuapp.com/travis/jemrobinson/octopusapi?env=OSBADGE=osx&label=%20&branch=main)](https://travis-ci.com/github/jemrobinson/octopusapi)
-![Linux](https://img.shields.io/badge/-555?&logo=linux&logoColor=white)[![Build Status](https://badges.herokuapp.com/travis/jemrobinson/octopusapi?env=OSBADGE=linux&label=%20&branch=main)](https://travis-ci.com/github/jemrobinson/octopusapi)
-![Windows](https://img.shields.io/badge/-555?&logo=windows&logoColor=white)[![Build Status](https://badges.herokuapp.com/travis/jemrobinson/octopusapi?env=OSBADGE=windows&label=%20&branch=main)](https://travis-ci.com/github/jemrobinson/octopusapi)
+![OSX](https://img.shields.io/badge/-555?&logo=apple&logoColor=white)[![Build Status](https://badges.formidable.com/travis.com/jemrobinson/octopusapi?branch=main&env=OSBADGE=osx&label=%20)](https://travis-ci.com/github/jemrobinson/octopusapi)
+![Linux](https://img.shields.io/badge/-555?&logo=linux&logoColor=white)[![Build Status](https://badges.formidable.com/travis.com/jemrobinson/octopusapi?branch=main&env=OSBADGE=linux&label=%20)](https://travis-ci.com/github/jemrobinson/octopusapi)
+![Windows](https://img.shields.io/badge/-555?&logo=windows&logoColor=white)[![Build Status](https://badges.formidable.com/travis.com/jemrobinson/octopusapi?branch=main&env=OSBADGE=windows&label=%20)](https://travis-ci.com/github/jemrobinson/octopusapi)
+
+## OctopusAPI
+This package provides a Python interface to the [Octopus Energy API](https://developer.octopus.energy/docs/api/).
+
+#### Dependencies
+- `Python >= 3.6`
+
+#### Install
+WIP
+<!-- Install with `pip` using
+
+```bash
+pip install octopusapi
+``` -->
+
+#### Deploy
+WIP
+
+#### Testing
+The automated tests can be run using
+
+```bash
+pytest
+```
+
+## Contribute
+Please look at [our contributing guidelines](CONTRIBUTING.md) if you want to contribute to this project. GitHub also has some good guides on [how to contribute](https://guides.github.com/activities/contributing-to-open-source/#contributing).
+
+## License
+This project uses a [GPL v3 licence](LICENSE).