Skip to content

Commit 52d5fa4

Browse files
committed
updated readme
1 parent 6ecaaa4 commit 52d5fa4

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ pip install oipd
4747
<br>
4848

4949

50-
OIPD has four core objects. A simple way to remember them is a 2x2 matrix:
50+
OIPD has four core objects.
51+
52+
A simple way to understand the package is by use case: fitting at a single future date vs over time, and working in implied volatility vs probabilities.
5153

5254
| Scope | Volatility Layer | Probability Layer |
5355
| --- | --- | --- |
@@ -187,7 +189,7 @@ Join the [Discord community](https://discord.gg/NHxWPGhhSQ) to share ideas, disc
187189

188190
[![Contributors](https://contrib.rocks/image?repo=tyrneh/options-implied-probability)](https://github.com/tyrneh/options-implied-probability/graphs/contributors)
189191

190-
**And special thanks for support on theory, implementation, or advice:**
192+
**And special thanks for support on theory, implementation, or advisory:**
191193
- [integral-alpha.com](https://integral-alpha.com)
192194
- Jannic H., Chun H. H., and Melanie C.
193195
- and others who prefer to go unnamed

docs/3_user-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ This page gives a practical map of how to use OIPD.
1010

1111
## 1. High-Level Mental Model
1212

13-
OIPD has four core objects. A simple way to remember them is a 2x2 matrix:
13+
OIPD has four core objects.
14+
15+
A simple way to understand the package is by use case: fitting at a single future date vs over time, and working in implied volatility vs probabilities.
1416

1517
| Scope | Volatility Layer | Probability Layer |
1618
| --- | --- | --- |

0 commit comments

Comments
 (0)