Skip to content

docs: README install section for v0.5.0 PyPI publish#31

Merged
chris-colinsky merged 1 commit into
mainfrom
docs/post-v0.5.0-readme-install
May 12, 2026
Merged

docs: README install section for v0.5.0 PyPI publish#31
chris-colinsky merged 1 commit into
mainfrom
docs/post-v0.5.0-readme-install

Conversation

@chris-colinsky
Copy link
Copy Markdown
Member

Summary

v0.5.0 is live on PyPI (https://pypi.org/project/openarmature/0.5.0/) — swap the README's "Not yet on PyPI" line for the actual pip install command plus an openarmature[otel] extras invocation. Editable-local instructions stay as the fallback for downstream-development workflows.

Test plan

  • CI green.
  • README renders correctly on GitHub (after merge).

v0.5.0 shipped to real PyPI; swap the "Not yet on PyPI"
note for the actual ``pip install openarmature`` command
plus an ``openarmature[otel]`` line for the OpenTelemetry
extras. Keeps the editable-local instructions as the
fallback for downstream-development workflows.
Copilot AI review requested due to automatic review settings May 12, 2026 00:53
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the README install instructions now that openarmature v0.5.0 is published to PyPI, providing direct pip install commands while keeping editable-local development steps as an alternative.

Changes:

  • Replace “Not yet on PyPI” text with pip install openarmature instructions.
  • Add an extras install example for OpenTelemetry via openarmature[otel].
  • Preserve the existing editable local development (uv add --editable ...) fallback.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chris-colinsky chris-colinsky merged commit ad76ec8 into main May 12, 2026
9 checks passed
@chris-colinsky chris-colinsky deleted the docs/post-v0.5.0-readme-install branch May 12, 2026 00:55
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