Merge pull request #20 from makeupsomething/patch-1

[EVA-2020-02-2.git] / library / README.rst

diff --git a/library/README.rst b/library/README.rst
index 6e2d507b0080d4946b69c2b090f380761d8d2134..f90e0720eda2696288304feed67d9bf9d9ad0bec 100644 (file)
--- a/library/README.rst
+++ b/library/README.rst
@@ -1,26 +1,30 @@
-Enviro pHAT Plus
-================
+Enviro+ pHAT
+============

 
 

-|Build Status| |Coverage Status| |PyPi Package| |Python Versions|
+`Build Status <https://travis-ci.com/pimoroni/enviroplus-python>`__
+`Coverage
+Status <https://coveralls.io/github/pimoroni/enviroplus-python?branch=master>`__
+`PyPi Package <https://pypi.python.org/pypi/enviroplus>`__ `Python
+Versions <https://pypi.python.org/pypi/enviroplus>`__

 
 Installing
 ==========
 
 Stable library from PyPi:
 
 
 Installing
 ==========
 
 Stable library from PyPi:
 

--  Just run ``sudo pip install envirophatplus``
+-  Just run ``sudo pip install enviroplus``
+
+(**Note** that you’re best using the git clone / install.sh method below
+if you want all of the UART serial configuration for the PMS5003
+particulate matter sensor to run automatically)

 
 Latest/development library from GitHub:
 
 
 Latest/development library from GitHub:
 

--  ``git clone https://github.com/pimoroni/envirophatplus-python``
--  ``cd envirophatplus-python``
+-  ``git clone https://github.com/pimoroni/enviroplus-python``
+-  ``cd enviroplus-python``

 -  ``sudo ./install.sh``
 
 -  ``sudo ./install.sh``
 

-.. |Build Status| image:: https://travis-ci.com/pimoroni/envirophatplus-python.svg?branch=master
-   :target: https://travis-ci.com/pimoroni/envirophatplus-python
-.. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/envirophatplus-python/badge.svg?branch=master
-   :target: https://coveralls.io/github/pimoroni/envirophatplus-python?branch=master
-.. |PyPi Package| image:: https://img.shields.io/pypi/v/envirophatplus.svg
-   :target: https://pypi.python.org/pypi/envirophatplus
-.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/envirophatplus.svg
-   :target: https://pypi.python.org/pypi/envirophatplus
+0.0.1
+-----
+
+* Initial Release