updated README and added images

MaiaNgo · Feb 20, 2019 · 805632b · 805632b
1 parent 33fb3c5
commit 805632b
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# Technical Analysis Library in Python
+# Technical Analysis Library in Python
+![Example Chart](/images/TA_Chart.png)
+
+Technical Analysis (TA) is an easy to use library that is built upon Python's Pandas library with more than 60 Indicators.  These indicators are comminly used for financial time series datasets with columns or labels similar to: datetime, open, high, low, close, volume, et al.  Many commonly used indicators are included, such as: _Moving Average Convergence Divergence_ (*MACD*), _Hull Exponential Moving Average_ (*HMA*), _Bollinger Bands_ (*BBANDS*), _On-Balance Volume_ (*OBV*), _Aroon Oscillator_ (*AROON*) and more.
+
+This version contains both the orignal code branch as well as a newly refactored branch with the option to use [Pandas DataFrame Extension](https://pandas.pydata.org/pandas-docs/stable/extending.html) mode. 
+All the indicators return a named Series or a DataFrame in uppercase underscore parameter format.  For example, MACD(fast=12, slow=26, signal=9) will return a DataFrame with columns: ['MACD_12_26_9', 'MACDH_12_26_9', 'MACDS_12_26_9'].
+
+
+
+# Inspiration
+Inspired by Bukosabino: https://github.com/bukosabino/ta
+
+Please leave any comments, feedback, or suggestions.
diff --git a/images/SPY_ADX.png b/images/SPY_ADX.png
diff --git a/images/SPY_ATR.png b/images/SPY_ATR.png
diff --git a/images/SPY_CumulativePercentReturn.png b/images/SPY_CumulativePercentReturn.png
diff --git a/images/SPY_MACD.png b/images/SPY_MACD.png
diff --git a/images/SPY_OBV.png b/images/SPY_OBV.png
diff --git a/images/SPY_ZScore.png b/images/SPY_ZScore.png
diff --git a/images/TA_Chart.png b/images/TA_Chart.png
diff --git a/setup.py b/setup.py
@@ -6,7 +6,7 @@
 setup(
     name = "pandas_ta",
     packages = ["pandas_ta"],
-    version = "0.0.2a",
+    version = "0.0.3a",
     description=long_description,
     long_description=long_description,
     author = "Kevin Johnson",