Skip to content

docs: update README with version compatibility and usage#28

Merged
damaz91 merged 3 commits into
mainfrom
update-readme
Jul 3, 2026
Merged

docs: update README with version compatibility and usage#28
damaz91 merged 3 commits into
mainfrom
update-readme

Conversation

@damaz91

@damaz91 damaz91 commented Jul 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Update README.md to include:

  • A table mapping UCP SDK version to UCP Schema version.
  • Usage examples for both TypeScript (ES Modules) and JavaScript (CommonJS) using Zod.

Category (Required)

  • Core Protocol: Changes to the base communication layer, global context, or breaking refactors. (Requires Technical Council approval)
  • Governance/Contributing: Updates to GOVERNANCE.md, CONTRIBUTING.md, or CODEOWNERS. (Requires Governance Council approval)
  • Capability: New schemas (Discovery, Cart, etc.) or extensions. (Requires Maintainer approval)
  • Documentation: Updates to README, or documentations regarding schema or capabilities. (Requires Maintainer approval)
  • Infrastructure: CI/CD, Linters, or build scripts. (Requires DevOps Maintainer approval)
  • Maintenance: Version bumps, lockfile updates, or minor bug fixes. (Requires DevOps Maintainer approval)
  • SDK: Language-specific SDK updates and releases. (Requires DevOps Maintainer approval)
  • Samples / Conformance: Maintaining samples and the conformance suite. (Requires Maintainer approval)
  • UCP Schema: Changes to the ucp-schema tool (resolver, linter, validator). (Requires Maintainer approval)
  • Community Health (.github): Updates to templates, workflows, or org-level configs. (Requires DevOps Maintainer approval)

Related Issues

None.

Checklist

  • I have followed the Contributing Guide (including Conventional Commits title requirements and ! for breaking changes).
  • I have updated the documentation (if applicable).
  • My changes pass all local linting and formatting checks.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • (For Core/Capability) I have included/updated the relevant JSON schemas.
  • I have regenerated Python Pydantic models by running generate_models.sh under python_sdk.

damaz91 added 2 commits July 3, 2026 08:06
@damaz91
docs: update README with version compatibility and usage
5e02f0c 
Update README.md to include:
- A table mapping UCP SDK version to UCP Schema version.
- Usage examples for both TypeScript (ES Modules) and JavaScript (CommonJS) using Zod.

TAG=agy
CONV=b0b2a44b-5125-4e9d-8d52-f65c701cf6fc
@damaz91
docs: correct UCP version compatibility mapping in README
1c45bd9 
Correct the mapping for 0.1.1 and 0.1.0 to match the correct UCP schema versions.

TAG=agy
CONV=b0b2a44b-5125-4e9d-8d52-f65c701cf6fc
@damaz91
damaz91 requested review from a team as code owners July 3, 2026 08:10
@damaz91 damaz91 added the status:needs-triage Signal that the PR is ready for human triage label Jul 3, 2026
@damaz91
damaz91 removed the request for review from archrao July 3, 2026 09:17
ptiper
ptiper approved these changes Jul 3, 2026
View reviewed changes

@ptiper ptiper left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Verified version compatibility mapping and usage examples.

@damaz91
damaz91 merged commit 92de604 into main Jul 3, 2026
15 checks passed
@damaz91
damaz91 deleted the update-readme branch July 3, 2026 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ptiper ptiper ptiper approved these changes
@carolinerg1 carolinerg1 Awaiting requested review from carolinerg1 carolinerg1 was automatically assigned from Universal-Commerce-Protocol/devops-maintainers
@nicholasjameshall nicholasjameshall Awaiting requested review from nicholasjameshall nicholasjameshall was automatically assigned from Universal-Commerce-Protocol/devops-maintainers
@westeezy westeezy Awaiting requested review from westeezy westeezy was automatically assigned from Universal-Commerce-Protocol/maintainers

Assignees

No one assigned

Labels

status:needs-triage Signal that the PR is ready for human triage

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@damaz91 @ptiper