Skip to content

update readme pitch #50

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

Merged
angela-tarantula merged 2 commits into from
Apr 8, 2026
Merged

update readme pitch #50

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8df6b7f
update readme
angela-tarantula Apr 8, 2026
83618af
Merge branch 'main' into update-readme-pitch
angela-tarantula Apr 8, 2026
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
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@

<!-- markdownlint-enable MD013 -->

<!--
Documentation:
[https://angela-tarantula.github.io/jsonpatchx](https://angela-tarantula.github.io/jsonpatchx)
-->

## About The Project

Expand All @@ -25,6 +27,10 @@ LLM-generated patch payloads.
- **Input Safety**: patch operations are Pydantic models, so malformed payloads
fail fast with clear, structured errors.

- **FastAPI Native**: set up PATCH routes quickly with minimal boilerplate, with
optional `application/json-patch+json` enforcement and a recommended HTTP
error mapping.

### It also provides extensibility beyond the RFC

- **Richer Operations**: define custom patch operations such as `increment`,
Expand All @@ -50,14 +56,6 @@ LLM-generated patch payloads.
- **Lifecycle Management**: evolve operation contracts over time with additive
schema changes and deprecations.

### Integrates cleanly with FastAPI

- **Protocol Enforcement**: require `application/json-patch+json` and publish
accurate request schemas with examples in OpenAPI.

- **Predictable Failures**: patch errors map to consistent HTTP responses (422,
409, 415) with structured details.

## Getting Started

### Installation
Expand Down
Loading