From e7824bba727b9f4a8e09b5a407cd9228553f02ba Mon Sep 17 00:00:00 2001 From: unknown Date: Wed, 17 Mar 2021 19:53:32 +0000 Subject: [PATCH] updated readme --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8be29b5..26e2a1a 100644 --- a/README.md +++ b/README.md @@ -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/) \ No newline at end of file