Skip to content

docs: expand README with installation, usage examples, and technical overview#1

Draft
Copilot wants to merge 2 commits intodevelopfrom
copilot/update-readme-installation-usage
Draft

docs: expand README with installation, usage examples, and technical overview#1
Copilot wants to merge 2 commits intodevelopfrom
copilot/update-readme-installation-usage

Conversation

Copy link

Copilot AI commented Feb 25, 2026

The README contained only a one-line description and a warning. It lacked any guidance on how to install or use the library.

Installation

Added three installation paths: dotnet add package, Install-Package, and direct <PackageReference>.

Usage examples

Added C# snippets for both directions of the serialization API:

// Deserialize
BurritoSerializationRoot? burrito = BurritoSerializer.Deserialize(json);

// Serialize
string json = BurritoSerializer.Serialize(burrito);

Technical overview (bottom of README)

  • Architecture section covering BurritoSerializer (public API) and BurritoContext (source-gen JsonSerializerContext)
  • Reference table of all 16 models/enums in ScriptureBurrito.Models
  • Documents the active System.Text.Json options: camelCase property naming, null omission, and string enum converters for MetaCategory and MetaNormalization

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: rbnswartz <724704+rbnswartz@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README with installation and usage details docs: expand README with installation, usage examples, and technical overview Feb 25, 2026
Copilot AI requested a review from rbnswartz February 25, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants