Skip to content

Commit

Permalink
chore: update readme (#149)
Browse files Browse the repository at this point in the history
---

<details open="true"><summary>Generated summary (powered by <a href="https://app.graphite.dev">Graphite</a>)</summary>

> ## TL;DR
> The README file for the "ogre" repository has been updated to include information about using json-patch RFC6902 for representing diffs. It also lists features such as reset, diff, and visualization via `@dotinc/ogre-react`. Additionally, there are plans for future updates including recursive merging.
> 
> ## What changed
> - Updated README file with information about using json-patch RFC6902 for representing diffs
> - Added features like reset, diff, and visualization via `@dotinc/ogre-react`
> - Mentioned plans for future updates including recursive merging
> 
> ## How to test
> - Review the updated README file in the "ogre" repository
> - Test the reset, diff, and visualization features using `@dotinc/ogre-react`
> - Stay tuned for future updates related to recursive merging
> 
> ## Why make this change
> - Provide users with information about representing diffs using json-patch RFC6902
> - Enhance user experience with features like reset, diff, and visualization
> - Plan for future updates to improve merging capabilities, including recursive merging
</details>
<!-- GITHUB_RELEASE PR BODY: canary-version -->
<details>
  <summary>📦 Published PR as canary version: <code>Canary Versions</code></summary>
  <br />

  ✨ Test out this PR locally via:
  
  ```bash
  npm install @dotinc/ogre@0.4.1-canary.149.8029125690.0
  npm install @dotinc/ogre-react@0.4.1-canary.149.8029125690.0
  # or 
  yarn add @dotinc/ogre@0.4.1-canary.149.8029125690.0
  yarn add @dotinc/ogre-react@0.4.1-canary.149.8029125690.0
  ```
</details>
<!-- GITHUB_RELEASE PR BODY: canary-version -->
  • Loading branch information
nadilas committed Feb 24, 2024
2 parents 6ef5251 + 251eaa0 commit 5149d6d
Show file tree
Hide file tree
Showing 4 changed files with 687 additions and 15 deletions.
10 changes: 6 additions & 4 deletions README.md
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

0 comments on commit 5149d6d

Please sign in to comment.