Complete Rewrite of the About section
This commit is contained in:
parent
3463ffe84d
commit
110d27dea9
15
README.md
15
README.md
@ -1,9 +1,18 @@
|
||||
# SimpleStockData
|
||||
|
||||
SimpleStockData is a simple library providing an API to access basic stock prices.
|
||||
You just have to specify a start and an end date, or a specific period, and - if
|
||||
needed - a currency to convert all stock prices to.
|
||||
SimpleStockData is a wrapper around the yfinance library providing very easy, high-level
|
||||
access to the yahoo finance data. It does NOT WRAP all features of yfinance, as this
|
||||
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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user