update README

README.md

@@ -12,7 +12,7 @@ or
 > pip install UniswapPy
 ```
 # Special Features
- * **Abstracted Actions**: Obvusication is removed from standard Uniswap action events to help streamline analysis and lower line count
+ * **Abstracted Actions**: Obfuscation is removed from standard Uniswap action events to help streamline analysis and lower line count
  * **Rebasing**: Can calculate settlment LP token amounts given token amounts and vice versa 
  * **Simulation**: Can simulate trading using Geometric Brownian Motion (GBM) process, or feed in actual raw price data to analyze behavior
  * **Randomized Events**: Token amount and time delta models to simulate possible trading behavior

UniswapPy.egg-info/PKG-INFO

@@ -1,9 +1,30 @@
 Metadata-Version: 2.1
 Name: UniswapPy
-Version: 1.0.1
+Version: 1.0.3
 Summary: Uniswap for Python
 Home-page: http://github.com/icmoore/uniswappy
 Author: icmoore
 Author-email: [email protected]
 License: MIT
+Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+
+# UniswapPy
+This package is a python re-factor of the original [Uniswap V2 pairing code](https://github.com/Uniswap/v2-core/blob/master/contracts/UniswapV2Pair.sol) and can be 
+utilized for the purpose of analysing and modelling its behavior for DeFi
+
+To install package:
+```
+> git clone https://github.com/icmoore/uniswappy
+> pip install .
+```
+or
+```
+> pip install UniswapPy
+```
+# Special Features
+ * **Abstracted Actions**: Obvusication is removed from standard Uniswap action events to help streamline analysis and lower line count
+ * **Rebasing**: Can calculate settlment LP token amounts given token amounts and vice versa 
+ * **Simulation**: Can simulate trading using Geometric Brownian Motion (GBM) process, or feed in actual raw price data to analyze behavior
+ * **Randomized Events**: Token amount and time delta models to simulate possible trading behavior
+ * **Revenue Tools**: Basic yeild calculators and risk tools to assist in analyzing outcomes

setup.py

@@ -1,8 +1,13 @@
 from setuptools import setup
 
+with open('README.md') as f:
+    long_description = f.read()
+
 setup(name='UniswapPy',
-      version='1.0.1',
+      version='1.0.3',
       description='Uniswap for Python',
+      long_description=long_description,
+      long_description_content_type="text/markdown",
       url='http://github.com/icmoore/uniswappy',
       author = "icmoore",
       author_email = "[email protected]",