Skip to content

docs(readme): reflect v1.2.0 published state - #2

Merged
KeyCode17 merged 1 commit into
mainfrom
docs/readme-refresh
May 18, 2026
Merged

docs(readme): reflect v1.2.0 published state#2
KeyCode17 merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@KeyCode17

Copy link
Copy Markdown
Owner

Summary

  • Drop the "Pre-MVP. No Rust code yet." banner — the workspace is shipped on crates.io as the pxsolver-* family.
  • Add install + quickstart sections (clone-to-curl in under a minute).
  • Update ADR count (23) and link deployment.md / threat-model.md / dual-use-policy.md directly from the README.
  • Report the chosen license (AGPL-3.0-or-later, already in the workspace Cargo.toml) and call out the missing top-level LICENSE file as a follow-up.

Why

The current README contradicts the repo state (15 ADRs vs 23, v0 planning vs v1.2.0 published) and gives no on-ramp for a new operator. A landing-page that points at deployment + threat-model + dual-use docs is also part of the Phase 04 / SOW-DEL-010 surface area.

Test plan

  • Visual review of rendered markdown (tables, code fences, anchors).
  • All linked files exist in this branch (docs/deployment.md, docs/threat-model.md, docs/dual-use-policy.md).
  • No code touched — lefthook fmt/clippy/test gates not relevant; commit-msg conventional gate passed.

🤖 Generated with Claude Code

Drop the "Pre-MVP. No Rust code yet." banner; the workspace is shipped
on crates.io as the `pxsolver-*` family and the MVP gate has been hit
since v1.0.0.

Add install (crates.io + source) and quickstart sections so a new
operator can get from clone to a working /v1/solve curl without
reading the ADR tree first. Refresh the ADR count (23) and add direct
links to deployment.md / threat-model.md / dual-use-policy.md.

License section now reports AGPL-3.0-or-later as the chosen license
(matches the workspace Cargo.toml) and notes the missing top-level
LICENSE file as a follow-up.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@KeyCode17
KeyCode17 merged commit 2764ce7 into main May 18, 2026
6 checks passed
@KeyCode17
KeyCode17 deleted the docs/readme-refresh branch May 18, 2026 07:41
KeyCode17 added a commit that referenced this pull request May 18, 2026
Lifts workspace.package.version 1.2.0 -> 1.3.0 and aligns the 16
internal workspace.dependencies pins from 1.1.0 -> 1.3.0 so published
metadata records the current release line.

Releases since 1.2.0:
- refactor(auth): deterministic allowlist list() ordering (#1)
- feat(server): graceful shutdown on SIGTERM / Ctrl-C (#4)
- feat(cli): complete Phase 04 subcommand surface (#3)
- docs(readme): reflect v1.2.0 published state (#2)
- ci(release): port rust-ai-surfer publish pattern

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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.

1 participant