Add separate README for PyPi

sslayer · Oct 19, 2016 · ad37c8c · ad37c8c
1 parent d5d8d10
commit ad37c8c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/MANIFEST.rst b/MANIFEST.rst
@@ -1 +1 @@
-include README.md
+include README.rst
diff --git a/README.rst b/README.rst
@@ -0,0 +1,16 @@
+MPU-6050 Python
+
+This program handles the I2C communication between a Raspberry Pi and a MPU-6050 Gyroscope/Accelerometer sensor.
+
+For this program to work you need to have I2C enabled on your Raspberry Pi and you need to have the python-smbus package installed.
+
+Using the module is quite straight-forward. You simply create an object of the
+mpu6050 class and use the appropriate methods to get your data.
+
+The following methods are available to read sensor data:
+
+```python
+get_accel_data()
+get_gyro_data()
+get_temp()
+```
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@ def readme():
         return f.read()
 
 setup(name='mpu6050-raspberrypi',
-    version='1.0.3',
+    version='1.0.3.1',
     description='A package to handle the i2c communication between a Raspberry Pi and a MPU-6050',
     classifiers=[
         'License :: OSI Approved :: MIT License',