documentation updates

Author: Martin O'Hanlon

README.rst

@@ -1,6 +1,8 @@
 picozero
 ========
 
+|pypibadge| |docsbadge|
+
 A beginner-friendly library for using common electronics components with the Raspberry Pi Pico.
 
 .. code-block:: python
@@ -19,9 +21,9 @@ A beginner-friendly library for using common electronics components with the Ras
 Status
 ------
 
-Pre-alpha - not yet for general release. Documentation is not yet available. There will be many bugs and issues.
+Beta. There will be bugs and issues. API changes are likely.
 
-Full documentation will be available at `picozero.readthedocs.io <https://picozero.readthedocs.io>`_ :
+Documentation is available at `picozero.readthedocs.io <https://picozero.readthedocs.io>`_ :
 
 - `Installation and getting started guide <https://picozero.readthedocs.io/en/latest/gettingstarted.html>`_
 - `Recipes and how-to's <https://picozero.readthedocs.io/en/latest/recipes.html>`_
@@ -32,3 +34,10 @@ Notes
 
 picozero is inspired by `gpiozero <https://gpiozero.readthedocs.io/en/stable/>`_ (and reuses some of its underlying structure), but is by design lighter weight and aligned with the Raspberry Pi Pico. Thank you to everyone who has contributed to the gpiozero project.
 
+.. |pypibadge| image:: https://badge.fury.io/py/picozero.svg
+   :target: https://badge.fury.io/py/picozero
+   :alt: Latest Version
+
+.. |docsbadge| image:: https://readthedocs.org/projects/picozero/badge/
+   :target: https://readthedocs.org/projects/picozero/
+   :alt: Docs

docs/contributing.rst

@@ -0,0 +1,34 @@
+Contributing
+============
+
+Contributions to the picozero are welcome. Here is some advice.
+
+1. picozero is 'lightweight', it is designed to be easy to use but also needs to run on a micro controller, please take this into account when considering feature requests or raising issues.
+2. see below for other stuff!
+
+Status
+------
+
+picozero is currently in Beta, pre release 1.0, you should consider the following:
+
+- The API is not yet set, however, this doesn't mean that backwards compatibility is not important! It is a balancing act.
+- Requests for new features will need to be prioritised and responses to feature requests may take some time.
+- Refactoring of the code base is very likely and as a result pull requests may need rework.
+- Issues are likely to exist within the code base, be kind!
+
+Suggestions
+-----------
+
+If you have an idea for a new feature or would like to see a device included in picozero, please raise an `issue`_. Please explain your reasoning clearly.
+
+Bugs 
+----
+
+Please raise an `issue`_ for any bugs found. Please include code examples and circuit diagrams if appropriate. 
+
+Pull requests
+-------------
+
+All pull requests should be based on the `dev <https://github.com/RaspberryPiFoundation/picozero/tree/dev>`_ branch of picozero. 
+
+.. _issue: https://github.com/RaspberryPiFoundation/picozero/issues

docs/developing.rst

@@ -37,4 +37,6 @@ To build the documentation, run the following command from the docs directory:
 
 The website will be built in the directory docs/_build/html.
 
-Documentation can be viewed at http://picozero.readthedocs.io/
+Documentation can be viewed at `picozero.readthedocs.io`_.
+
+.. _picozero.readthedocs.io: https://picozero.readthedocs.io

docs/index.rst

@@ -11,4 +11,5 @@ Table of Contents
    recipes
    api
    developing
+   contributing
    changelog