From d402f7e7f6060c17055c4011a8173d02b6cc1591 Mon Sep 17 00:00:00 2001 From: BlueFox Date: Fri, 24 Nov 2023 23:07:48 +0100 Subject: [PATCH] Added simple numbering for better readability in README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6d2ca15..32eca8c 100644 --- a/README.md +++ b/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.