docs: document version command

[PewterZz]

Adds ergosum-proxy version to the Use section of the README — the command was added in #1 but not documented.

Summary by CodeRabbit

• New Features

  • Added a CLI command for retrieving the proxy version after startup.

• Documentation

  • Updated the README with version command usage and instructions.

[coderabbitai]

📝 Walkthrough

Walkthrough

The README documentation was updated to include instructions for using a new CLI command: ergosum-proxy version. This command displays the proxy's version number. The change is documentation-only with no code modifications.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added usage documentation for the ergosum-proxy version CLI command to display the proxy version.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A version command, neat and bright,
Now documented in our sight,
Three lines added, clean and true,
Version checking—simple to do!

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: documenting the version command in the README.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch dev

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

README.md (1)

33-34: Consider documenting the --version and -V flags.

The CLI parser also supports --version and -V flags (as shown in src/index.ts:85-90), but these are not mentioned in the README. Adding them would improve discoverability for users who might try the conventional --version flag.

📝 Suggested documentation enhancement

 # Print version
-ergosum-proxy version
+ergosum-proxy version  # or --version, -V

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 33 - 34, The README's "Print version" section is
missing documentation for the CLI's supported --version and -V flags; update the
README (under the "Print version" heading) to mention that the CLI supports both
--version and -V (alias) and show their expected output/usage (e.g.,
"ergosum-proxy --version" prints the current version), referencing the CLI
parser's version flag behavior implemented in the index CLI code (the flags
handled around the version parsing logic). Ensure the new text briefly states
both flag names and an example invocation.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Around line 33-34: The README's "Print version" section is missing
documentation for the CLI's supported --version and -V flags; update the README
(under the "Print version" heading) to mention that the CLI supports both
--version and -V (alias) and show their expected output/usage (e.g.,
"ergosum-proxy --version" prints the current version), referencing the CLI
parser's version flag behavior implemented in the index CLI code (the flags
handled around the version parsing logic). Ensure the new text briefly states
both flag names and an example invocation.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 069d6530-7cb7-4582-bc73-ab4990bc25f2

📥 Commits

Reviewing files that changed from the base of the PR and between 8f17b7c and 3010241.

📒 Files selected for processing (1)

• README.md