Skip to content

Commit 5e5d089

Browse files
committed
Documentation
1 parent 95f88a0 commit 5e5d089

2 files changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,22 @@ pip install .
7070
This will install all the dependencies listed in the `setup.py` file. Once done
7171
you can use the library wherever you want.
7272

73+
**Setup - PyPi Install:**
74+
75+
To install the library, run the following command from the terminal.
76+
77+
```console
78+
pip install python-sec
79+
```
80+
81+
**Setup - PyPi Upgrade:**
82+
83+
To upgrade the library, run the following command from the terminal.
84+
85+
```console
86+
pip install --upgrade python-sec
87+
```
88+
7389
## Usage
7490

7591
Here is a simple example of using the `pysec` library to grab the index files for specific quarter.

setup.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@
1616
# also an email they can use to reach out.
1717
author_email='coding.sigma@gmail.com',
1818

19-
# I'm in alpha development still, so a compliant version number is a1.
20-
# read this as MAJOR VERSION 0, MINOR VERSION 1, MAINTENANCE VERSION 0
19+
# define the version of the package.
2120
version='0.1.2',
2221

2322
# here is a simple description of the library, this will appear when someone searches for the library on https://pypi.org/search

0 commit comments

Comments
 (0)