Skip to content

Commit

Permalink
Update README.md with usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Shreyas Srinivasan committed Feb 17, 2022
1 parent c111c43 commit 2b4e8e6
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@ Updating is also done through PIP; enter the following on the command line:
$ pip3 install fixedincome-analytics -U
```

## Documentation
## Usage
This package is named `fixedincome`. We recommend using it in Python via
```python3
import fixedincome as fi
```

### Documentation
Documentation is available through Python's built-in `help()` function. As an example, we can see package-level documentation using the following Python code:
```python3
import fixedincome as fi
Expand Down
2 changes: 1 addition & 1 deletion VERSION.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.0
0.1.1

0 comments on commit 2b4e8e6

Please sign in to comment.