diff --git a/README.md b/README.md index 81ace69..980fc93 100755 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ which is: 1. Grap the history of a specific stock 2. Select a specific period of time (via parameters `start` and `end`) 3. Directly convert the data to another currency¹ +4. CLI and library accessibility That's pretty much all. And all this just very convenient. @@ -15,10 +16,21 @@ That's pretty much all. And all this just very convenient. ¹ for example, the given stocks are in different currencies, and you want all of your stocks be written to your diagram in the same currency + +## 0. Legal Disclaimer +*** IMPORTANT LEGAL DISCLAIMER *** + +Yahoo!, Y!Finance, and Yahoo! finance are registered trademarks of Yahoo, Inc. + +SimpleStockData is not affiliated, endorsed, or vetted by Yahoo, Inc. It's an open-source tool that uses Yahoo's publicly available APIs, and is intended for research and educational purposes. + +You should refer to Yahoo!'s terms of use ([here](https://policies.yahoo.com/us/en/yahoo/terms/product-atos/apiforydn/index.htm), [here](https://legal.yahoo.com/us/en/yahoo/terms/otos/index.html) and [here](https://policies.yahoo.com/us/en/yahoo/terms/index.htm)) for details on your rights to use the actual data downloaded. Remember - the Yahoo! finance API is intended for personal use only. + +[[see also]](https://pypi.org/project/yfinance/) ## 1. Installation ### 1.1 Requirements - + Python >= 2.7, 3.4+ Pandas >= 1.3.0 Numpy >= 1.16.5 @@ -37,22 +49,10 @@ Requirements from yfinance ### 1.2 Installing these To get started using the library, the pip packages named in 1.1 have to be installed. To do this, type in the following: -```commandline +```shell pip3 install numpy pandas yfinance requests lxml ``` -### 1.3 Legal Disclaimer -*** IMPORTANT LEGAL DISCLAIMER *** - -Yahoo!, Y!Finance, and Yahoo! finance are registered trademarks of Yahoo, Inc. - -SimpleStockData is not affiliated, endorsed, or vetted by Yahoo, Inc. It's an open-source tool that uses Yahoo's publicly available APIs, and is intended for research and educational purposes. - -You should refer to Yahoo!'s terms of use ([here](https://policies.yahoo.com/us/en/yahoo/terms/product-atos/apiforydn/index.htm), [here](https://legal.yahoo.com/us/en/yahoo/terms/otos/index.html) and [here](https://policies.yahoo.com/us/en/yahoo/terms/index.htm)) for details on your rights to use the actual data downloaded. Remember - the Yahoo! finance API is intended for personal use only. - -[[see also]](https://pypi.org/project/yfinance/) - - ## 2. Usage ### 2.1 If used as a CLI: