docs(readme): catch up on commands shipped since v0.0.1-rc-5#101
Merged
Conversation
The README hadn't been updated since the OSS-readiness scaffolding in #75 (May), so several command groups added since then were missing entirely. This commit documents them and brings install + testing sections in line with current state. New sections: - nbctl audit-logs list - nbctl events list-rules / list-triage-rules / list-duplicates - nbctl slo list / get - nbctl tickets list-configurations / create - nbctl workflow list / get / apply / validate / delete / trigger / pause / resume / list-executions / get-execution / cancel-execution Updated: - Features list — mentions the new resources, MCP server, workflow lifecycle, and ticket integrations. - Go version requirement: 1.16+ -> 1.25+ (matches go.mod). - Testing section: documents the e2e build tag and `make test-e2e` target introduced in #95. No code changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README documentation to reflect new CLI capabilities in nbctl, including commands for audit logs, event rules, SLOs, ticket integrations, and workflow management. It also updates the Go installation requirement to version 1.25 or higher and documents the updated end-to-end testing procedures. The reviewer suggested replacing the unquoted <event-id> placeholder in the bash example with a quoted string to prevent shell redirection issues.
- Add 4 shields.io badges at the top: CI status, latest release, license, and Go version. Standard OSS signal at first glance. - Add a top-of-document Quickstart: install -> configure -> run one command in under a minute. Sits between Installation and the deep-dive Configuration section so new users don't have to scroll past 100+ lines of reference before seeing anything actionable. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
RamanKharchee
approved these changes
Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README catch-up before the OSS launch. The README hasn't been updated since the OSS-readiness scaffolding in #75 (May), so several command groups added since then were missing entirely.
New sections
Updated
No code changes.
Stats
+288 / -7 lines. README is now 966 lines (up from 685).
🤖 Generated with Claude Code