Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hashABCD committed Mar 17, 2021
1 parent 470a749 commit e7824bb
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# opstrat
Option visualization python package

opstrat is a Python library for visualizing options.

## Version
0.0.1

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.

```bash
pip install opstrat==0.0.2
```

## Usage

```python
import opstrat

opstrat.basic.option_plotter() # plots a basic option payoff diagram
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit e7824bb

Please sign in to comment.