Skip to content

Commit

Permalink
docs: feature list in README
Browse files Browse the repository at this point in the history
  • Loading branch information
15r10nk committed Dec 10, 2023
1 parent 9258b59 commit 30092dd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ You can install "inline-snapshot" via [pip](https://pypi.org/project/pip/):
pip install inline-snapshot
```

## Features

* easy semantics, because `snapshot(x)` can be seen as `x`
* support for `x == snapshot(...)`, `x <= snapshot(...)`, `x in snapshot(...)`, `snapshot(...)[key]`
* black formatting is preserved
* store snapshots in external files with `outsource(data)`
* pytest integration
* [documentation](https://15r10nk.github.io/inline-snapshot/)

## Usage

You can use `snapshot()` instead of the value which you want to compare with.
Expand Down
2 changes: 1 addition & 1 deletion docs/outsource.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This has the advantage that you can easily see changes in code reviews. But it a
* It is problematic to snapshot a lot of data, because it takes up a lot of space in your tests.
* Binary data or images are not readable in your tests.

The `outsource(...)` function solves this problem and integrates itself nicely with the inline snapshot.
The `outsource()` function solves this problem and integrates itself nicely with the inline snapshot.
It stores the data in a special `external()` object that can be compared in snapshots.
The object is represented by the hash of the data.
The actual data is stored in a separate file in your project.
Expand Down

0 comments on commit 30092dd

Please sign in to comment.