Updated readme file

Author: fourstix

README.rst

@@ -13,7 +13,8 @@ Introduction
     :target: https://travis-ci.org/fourstix/Sparkfun_CircuitPython_QwiicJoystick
     :alt: Build Status
 
-CircuitPython library for Sparkfun Qwiic Joystick
+CircuitPython library for Sparkfun Qwiic Joystick.  This library is ported from the 
+`SparkFun Qwiic Joystick Arduino Library <https://github.com/sparkfun/SparkFun_Qwiic_Joystick_Arduino_Library>`_
 
 .. image:: https://cdn.sparkfun.com/assets/parts/1/3/5/5/8/15168-SparkFun_Qwiic_Joystick-01.jpg
     :target: https://www.sparkfun.com/products/15168
@@ -35,10 +36,46 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
 This is easily achieved by downloading
 `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
 
+Raspberry Pi Setup
+------------------
+   Adafruit has an excellent tutorial on this: 
+   `Installing CircuitPython Libraries on Raspberry Pi
+   <https://learn.adafruit.com/circuitpython-on-raspberrypi-linux/installing-circuitpython-on-raspberry-pi/>`_.
+ 
+Quick Start Summary:
+* Start with the latest version of Raspbian with Wifi configured.
+* Enable SSH, I2C and SPI.
+.. code-block:: shell
+
+    sudo raspi-config
+
+* Update your system to the latest version.
+.. code-block:: shell
+
+    sudo apt-get update
+    sudo apt-get upgrade
+
+* Update the python tools
+.. code-block:: shell
+
+    sudo pip3 install --upgrade setuptools
+(If pip3 is not installed, install it and rerun the command)
+.. code-block:: shell
+    sudo apt-get install python3-pip
+* Install the CircuitPython libraries
+.. code-block:: shell
+
+    pip3 install RPI.GPIO
+    pip3 install adafruit-blinka
+    pip3 install 
+
+
 Installing from PyPI
 --------------------
    On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
    PyPI <https://pypi.org/project/sparkfun-circuitpython-qwiicjoystick/>`_. To install for current user:
+   Installing this library will also install the dependency adafruit-circuitpython-busdevice.
+
 
 .. code-block:: shell
 
@@ -63,6 +100,19 @@ Usage Example
 =============
 * `Qwiic Joystick Hookup Guide <https://learn.sparkfun.com/tutorials/qwiic-joystick-hoookup-guide>`_ - The Arduino examples in the Hookup Guide are available for Python with this library
 * `CircuitPython on a Raspberry Pi <https://learn.adafruit.com/circuitpython-on-raspberrypi-linux>`_ - Basic information on how to install CircuitPython on a Raspberry Pi.
+* Example:
+ .. code-block:: shell
+
+     # import the CircuitPython board and busio libraries
+     import board
+     import busio
+
+     # Create bus object using the board's I2C port
+     i2c = busio.I2C(board.SCL, board.SDA)
+
+     joystick = QwiicJoystick(i2c)  # default address is 0x20
+     # use QwiicJoystick(i2c, address) for a different address
+         # joystick = QwiicJoystick(i2c, 0x21)"""
 
 Contributing
 ============

sparkfun_qwiicjoystick.py

@@ -76,7 +76,19 @@
 
 # class
 class Sparkfun_QwiicJoystick:
-    """CircuitPython class for the Sparkfun QwiicJoystick"""
+    """CircuitPython class for the Sparkfun QwiicJoystick
+       Usage:
+         # import the CircuitPython board and busio libraries
+         import board
+         import busio
+
+         # Create bus object using the board's I2C port
+         i2c = busio.I2C(board.SCL, board.SDA)
+
+         joystick = QwiicJoystick(i2c)  # default address is 0x20
+         # use QwiicJoystick(i2c, address) for a different address
+         # joystick = QwiicJoystick(i2c, 0x21)"""
+
 
     def __init__(self, i2c, address=QWIIC_JOYSTICK_ADDR, debug=False):
         """Initialize Qwiic Joystick for i2c communication."""
@@ -89,21 +101,21 @@ def __init__(self, i2c, address=QWIIC_JOYSTICK_ADDR, debug=False):
 
     @property
     def connected(self):
-        """Check the id of Joystick.  Returns True if successful."""
+        """True if the Joystick is connected and a valid id is successful read."""
         if self._read_register(_JOYSTICK_ID) != QWIIC_JOYSTICK_ADDR:
             return False
         return True
 
     @property
     def version(self):
-        """Return the version string for the Joystick firmware."""
+        """Firmware version string for joystick."""
         major = self._read_register(_JOYSTICK_VERSION1)
         minor = self._read_register(_JOYSTICK_VERSION2)
         return 'v' + str(major) + '.' + str(minor)
 
     @property
     def horizontal(self):
-        """Return the X value 0 - 1023 of the joystick postion."""
+        """X value from 0 - 1023 of the joystick postion."""
         # Read MSB for horizontal joystick position
         x_msb = self._read_register(_JOYSTICK_X_MSB)
         # Read LSB for horizontal joystick position
@@ -115,7 +127,7 @@ def horizontal(self):
 
     @property
     def vertical(self):
-        """Return the Y value 0 to 1023 of the joystick postion."""
+        """Y value from 0 to 1023 of the joystick postion."""
         # Read MSB for veritical joystick position
         y_msb = self._read_register(_JOYSTICK_Y_MSB)
         # Read LSB for vertical joystick position
@@ -127,14 +139,14 @@ def vertical(self):
 
     @property
     def button(self):
-        """Return 0 if button is down, 1 if up."""
+        """0 if button is down, 1 if button is up."""
         button = self._read_register(_JOYSTICK_BUTTON)
         return button
 
     # Issue: register 0x08 always contains 1 for some reason, even when cleared
     @property
     def button_status(self):
-        """Return 1 if button pressed between reads. Button status is cleared."""
+        """1 if button pressed between reads, cleared after read."""
         #read button status (since last check)
         status = self._read_register(_JOYSTICK_STATUS)
         #clear button status