Added simple numbering for better readability in README.md
This commit is contained in:
parent
c5003b9665
commit
d402f7e7f6
14
README.md
14
README.md
@ -5,7 +5,7 @@ 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.
|
||||
|
||||
|
||||
## Installation
|
||||
## 1. Installation
|
||||
|
||||
To get started using the library, the pip packages `numpy`, `pandas` and `yfinance`
|
||||
have to be installed. To do this, type in the following:
|
||||
@ -13,7 +13,7 @@ have to be installed. To do this, type in the following:
|
||||
pip3 install numpy pandas yfinance
|
||||
```
|
||||
|
||||
### Legal Disclaimer
|
||||
### 1.1 Legal Disclaimer
|
||||
*** IMPORTANT LEGAL DISCLAIMER ***
|
||||
|
||||
Yahoo!, Y!Finance, and Yahoo! finance are registered trademarks of Yahoo, Inc.
|
||||
@ -25,16 +25,16 @@ You should refer to Yahoo!'s terms of use (here, here, and here) for details on
|
||||
[[see also]](https://pypi.org/project/yfinance/)
|
||||
|
||||
|
||||
## Usage
|
||||
## 2. Usage
|
||||
|
||||
### If used as a CLI:
|
||||
### 2.1 If used as a CLI:
|
||||
TODO;
|
||||
|
||||
### If used as a Module in Python (via `import`):
|
||||
### 2.2 If used as a Module in Python (via `import`):
|
||||
TODO;
|
||||
|
||||
|
||||
## Thanks to
|
||||
## 3. Thanks to
|
||||
- [yfinance](https://pypi.org/project/yfinance/) - the library used in the background
|
||||
to get stock prices and exchange rates from Yahoo Finance.
|
||||
|
||||
@ -44,7 +44,7 @@ to get stock prices and exchange rates from Yahoo Finance.
|
||||
precise calculations
|
||||
|
||||
|
||||
## License (Unlicense)
|
||||
## 4. License (Unlicense)
|
||||
|
||||
``
|
||||
This is free and unencumbered software released into the public domain.
|
||||
|
Loading…
Reference in New Issue
Block a user