update README

Author: sommersoft

README.rst

@@ -6,11 +6,17 @@ Introduction
     :target: https://circuitpython.readthedocs.io/projects/irremote/en/latest/
     :alt: Documentation Status
 
-.. image :: https://badges.gitter.im/adafruit/circuitpython.svg
-    :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
-    :alt: Gitter
+.. image :: https://img.shields.io/discord/327254708534116352.svg
+    :target: https://discord.gg/nBQh6qu
+    :alt: Discord
 
-TODO
+CircuitPython driver for use with IR Receivers.
+
+Examples of products to use this library with:
+
+* `CircuitPlayground Express <https://www.adafruit.com/product/3333>`_
+
+* `IR Receiver Sensor <https://www.adafruit.com/product/157>`_
 
 Dependencies
 =============
@@ -25,7 +31,20 @@ This is easily achieved by downloading
 Usage Example
 =============
 
-TODO
+.. code-block:: python
+
+    # CircuitPlayground Express Demo Code
+    # Adjust the pulseio 'board.PIN' if using something else
+    import pulseio
+    import board
+    import adafruit_irremote
+
+    with pulseio.PulseIn(board.REMOTEIN, maxlen=120, idle_state=True) as p:
+        d = adafruit_irremote.GenericDecode()
+        code = bytearray(4)
+        while True:
+            d.decode(p, code)
+            print(code)
 
 Contributing
 ============
@@ -34,10 +53,49 @@ Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_irremote/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
-API Reference
-=============
+Building locally
+================
+
+To build this library locally you'll need to install the
+`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
+
+.. code-block:: shell
+
+    python3 -m venv .env
+    source .env/bin/activate
+    pip install circuitpython-build-tools
+
+Once installed, make sure you are in the virtual environment:
+
+.. code-block:: shell
+
+    source .env/bin/activate
+
+Then run the build:
+
+.. code-block:: shell
+
+    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-irremote --library_location .
+
+Sphinx documentation
+-----------------------
+
+Sphinx is used to build the documentation based on rST files and comments in the code. First,
+install dependencies (feel free to reuse the virtual environment from above):
+
+.. code-block:: shell
+
+    python3 -m venv .env
+    source .env/bin/activate
+    pip install Sphinx sphinx-rtd-theme
+
+Now, once you have the virtual environment activated:
+
+.. code-block:: shell
 
-.. toctree::
-   :maxdepth: 2
+    cd docs
+    sphinx-build -E -W -b html . _build/html
 
-   api
+This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
+view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
+locally verify it will pass.