Skip to content

Commit 8cb8331

Browse files
Update README
1 parent c661210 commit 8cb8331

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ matplotview provides a simple interface for creating "views" of matplotlib
55
axes, providing a simple way of displaying overviews and zoomed views of
66
data without plotting data twice.
77

8+
## Usage
9+
10+
matplotview provides two methods, `view`, and `inset_zoom_axes`. The `view`
11+
method accepts two `Axes`, and makes the first axes a view of the second. The
12+
`inset_zoom_axes` method provides the same functionality as `Axes.inset_axes`,
13+
but the returned inset axes is configured to be a view of the parent axes.
14+
815
## Examples
916

1017
An example of two axes showing the same plot.
@@ -34,7 +41,7 @@ fig.show()
3441
```
3542
![First example plot results, two views of the same plot.](_images/example1.png)
3643

37-
An inset zoom example.
44+
An inset axes example .
3845
```python
3946
from matplotlib import cbook
4047
import matplotlib.pyplot as plt

0 commit comments

Comments
 (0)