Start Readme

This commit is contained in:
Jamie
2021-05-21 20:45:59 -04:00
parent 556e6e284b
commit 5784dde7da
2 changed files with 32 additions and 1 deletions

View File

@@ -0,0 +1,31 @@
# ETF
Menu for Exchange Traded Funds.
Data is currently scraped from StockAnalysis.com/etf
* [web](#web)
* open webbroswer to stockanalysis.com
* [search](#search)
* search for ETFS matching an input
* [overview](#overview)
* get ETF overview
* [holdings](#holdings)
* show ETF holdings
* [compare](#compare)
* compare multiple ETFs overview
## web <a name="web"></a>
```python
usage: web
```
Opens StockAnalysis.com/etf. This site shows all avalaiable ETFs (currently > 2800).
## search <a name="search"></a>
```python
usage: search [-n --name]
```
Search for ETFs matching
* -n/--name : Name to search for. Can be a company or other

View File

@@ -36,7 +36,7 @@ def open_web():
def name_search(other_args: List[str]):
"""
Search all available etfs for matching
Search all available etfs for matching input
Parameters
----------
other_args: List[str]