add readme, index docs

Author: brentru

README.rst

@@ -13,8 +13,7 @@ Introduction
     :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_binascii
     :alt: Build Status
 
-Helpers for conversions between binary and ASCII
-
+The binascii module contains a number of methods to convert between binary and various ASCII-encoded binary representations.
 
 Dependencies
 =============
@@ -31,9 +30,6 @@ Installing from PyPI
 .. note:: This library is not available on PyPI yet. Install documentation is included
    as a standard element. Stay tuned for PyPI availability!
 
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
-
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-binascii/>`_. To install for current user:
 
@@ -59,7 +55,21 @@ To install in a virtual environment in your current project:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+Hex <-> Binary Conversions
+
+.. code-block:: python
+
+        from adafruit_binascii import hexlify, unhexlify
+        # Binary data.
+        data = b"CircuitPython is Awesome!"
+
+        # Get the hexadecimal representation of the binary data
+        hex_data = hexlify(data)
+        print("Hex Data: ", hex_data)
+
+        # Get the binary data represented by hex_data
+        bin_data = unhexlify(hex_data)
+        print("Binary Data: ", bin_data)
 
 Contributing
 ============

docs/index.rst

@@ -23,14 +23,10 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
 
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
 
 .. toctree::
     :caption: Other Links

examples/binascii_simpletest.py

@@ -1,22 +1,33 @@
 from adafruit_binascii import hexlify, unhexlify, a2b_base64, b2a_base64
 
+print("-- Binary<->Hex Conversions --")
 # Binary data.
 data = b"CircuitPython is Awesome!"
+print("Original Binary Data: ", data)
 
 # Get the hexadecimal representation of the binary data
 hex_data = hexlify(data)
 # Verify data
-assert (
-    hex_data == b"43697263756974507974686f6e20697320417765736f6d6521",
-), "hexlified data does not match expected data."
+print("Hex Data: ", hex_data)
+assert hex_data == b"43697263756974507974686f6e20697320417765736f6d6521", "hexlified data does not match expected data."
 
 # Get the binary data represented by hex_data
 bin_data = unhexlify(hex_data)
+print("Binary Data: ", bin_data)
 # Verify data
 assert bin_data == data, "unhexlified binary data does not match original binary data."
 
+print("-- Base64 ASCII <-> Binary Conversions --")
+data = b"Blinka"
+print("Original Binary Data: ", data)
 # Convert binary data to a line of ASCII characters in base64 coding.
-assert b2a_base64(b"Blinka") == b"Qmxpbmth\n", "Expected base64 coding does not match."
+b64_ascii_data = b2a_base64(data)
+print("Base64 ASCII Data: ", b64_ascii_data)
+assert b64_ascii_data == b"Qmxpbmth\n", "Expected base64 coding does not match."
 
 # Convert a block of base64 data back to binary data.
-assert a2b_base64(b"Qmxpbmth\n") == b"Blinka", "Expected binary data does not match."
+bin_data = a2b_base64(b"Qmxpbmth\n")
+print("Converted b64 ASCII->Binary Data: ", bin_data)
+assert bin_data == data, "Expected binary data does not match."
+
+print("All checks OK!")