Complete Rewrite of the About section

This commit is contained in:
BlueFox 2023-11-26 21:28:38 +01:00
parent 3463ffe84d
commit 110d27dea9

View File

@ -1,9 +1,18 @@
# SimpleStockData # SimpleStockData
SimpleStockData is a simple library providing an API to access basic stock prices. SimpleStockData is a wrapper around the yfinance library providing very easy, high-level
You just have to specify a start and an end date, or a specific period, and - if access to the yahoo finance data. It does NOT WRAP all features of yfinance, as this
needed - a currency to convert all stock prices to. would obviously make the whole thing unnecessary. It only provides very basic functionality,
which is:
1. Grap the history of a specific stock
2. Select a specific period of time (via parameters `from` and `to`)
3. Directly convert the data to another currency¹
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
## 1. Installation ## 1. Installation