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

Jump to bottom

chore: update readme #149

Merged
merged 1 commit into from
Feb 24, 2024
Merged

chore: update readme #149

Show file tree
Hide file tree
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
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ogre

An in-memory git-like repository for objects for when you need to
keep the history around for a bit longer.
keep the history around for a bit longer. The library uses json-patch RFC6902 for representing diffs.

[![codecov](https://codecov.io/gh/dotindustries/ogre/branch/main/graph/badge.svg?token=23M014CWLK)](https://codecov.io/gh/dotindustries/ogre) [![Test coverage](https://github.com/dotindustries/ogre/actions/workflows/coverage.yml/badge.svg)](https://github.com/dotindustries/ogre/actions/workflows/coverage.yml)

Expand All @@ -11,9 +11,11 @@ keep the history around for a bit longer.
- Branch
- Tags
- Checkout
- Reset (soft and hard)
- Diff
- Visualization via `@dotinc/ogre-react`
- Merge
- fast-forward
- fast-forward

## Usage

Expand Down Expand Up @@ -51,5 +53,5 @@ repo.checkout(init);
## TODO

- [ ] Merge
- [ ] recursive
- [ ] octopus
- [ ] recursive
- [ ] octopus
Loading
Loading