Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add Integration in README #5

Merged
merged 1 commit into from
Sep 18, 2023
Merged

chore: add Integration in README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,29 @@ Similar to [Jest Snapshot][jest-snapshot], but implemented in C++.
* `SNAPSHOT_DIFF(before_content, after_content)` required `git` binary.
* Support Linux and macOS.

## Integration

### CMake

```cmake
FetchContent_Declare(
snapshot
QUIET
GIT_REPOSITORY https://github.com/Dup4/snapshot-cpp.git
GIT_TAG v{x.y.z} # Where `x.y.z` is the release version you want to use.
)
```

### Bazel

```bazel
git_repository(
name = "snapshot",
remote = "https://github.com/Dup4/snapshot-cpp.git",
tag = "v{x.y.z}", # Where `x.y.z` is the release version you want to use.
)
```

## Usage

<a href="https://asciinema.org/a/608449" target="_blank">
Expand Down