chore: update readme

[nadilas]

---

Generated summary (powered by Graphite)

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

📦 Published PR as canary version: Canary Versions

✨ Test out this PR locally via:

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
ogre	⬜️ Ignored (Inspect)	Visit Preview		Feb 24, 2024 7:36am

[nadilas]

Current dependencies on/for this PR:

• chore: update readme #149 👈
• main

This stack of pull requests is managed by Graphite.

[socket-security]

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source
Install scripts	npm/esbuild@0.19.12	Install script: postinstall Source: node install.js	orphan: npm/esbuild@0.19.12

View full report↗︎

Next steps

What is an install script?

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

• @SocketSecurity ignore npm/esbuild@0.19.12

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.39%. Comparing base (1dd4066) to head (251eaa0).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #149   +/-   ##
=======================================
  Coverage   77.39%   77.39%           
=======================================
  Files           6        6           
  Lines         323      323           
  Branches       71       71           
=======================================
  Hits          250      250           
  Misses         49       49           
  Partials       24       24           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

🚀 PR was released in @dotinc/ogre-cli@0.2.0, @dotinc/ogre-react@0.5.0, @dotinc/ogre@0.5.0 🚀