docs - fix install instructions and drop broken PyPI badge

[kthhrv]

Summary

• pip install envars was wrong. This project is not published to PyPI. The envars name there belongs to an unrelated third-party project (envars 0.3.5, "Read environmental variables", last released 2021-07-12) whose wheel ships no console-script entry point — so the documented command silently installed a stranger's library and left the user with no envars command. README and Getting Started now document the git install this repo is actually consumed by (doer and doer2 both depend on git+…/envars2).
• Dropped the PyPI version badge. It pointed at badge.fury.io/py/envars2; pypi.org/pypi/envars2/ and pypi.org/simple/envars2/ both 404. Nothing would ever publish it either — devops/pr-buildspec.yml and devops/master-buildspec.yml stop at pre-commit + pytest, there is no publish phase. The Read the Docs badge is live and stays.
• Replaced leftover your-username placeholder clone URLs in README.md, docs/project/contributing.md and docs/project/ARCHITECTURE.md with timeoutdigital/envars2.
• contributing.md corrections: it pointed at a placeholder fork URL and told contributors to open a PR against main; the default branch is master. The clone/push steps now describe the direct path for people with write access and say to fork first for those without.

The broken install instruction is currently live on https://envars.readthedocs.io/en/latest/getting-started/, so this also fixes the published docs.

Review round 1

• Accepted (af6bcac): keep a fork path in contributing.md for contributors without write access; describe the unpinned install as tracking the default branch (currently master) rather than the literal branch name.
• Declined: adding a .git suffix to the VCS URLs. Both documented commands were run end-to-end against these exact URLs and install a working CLI, git ls-remote resolves the suffix-less URL, and the suffix-less form matches the existing pins in doer and doer2.

Not included

pyproject.toml still declares version = "0.1.0" while release tags are 1.0.0–1.0.4 — a real inconsistency (an install from tag 1.0.4 reports version 0.1.0), but out of scope for a docs-only change.

Test plan

• pip install "git+https://github.com/timeoutdigital/envars2@1.0.4" into a clean venv → installs and envars --help prints the CLI
• uv add "envars @ git+https://github.com/timeoutdigital/envars2@1.0.4" in a fresh uv init project → uv run envars --help works
• mkdocs build --strict (the exact command .readthedocs.yaml runs) builds clean, and the reworked contributing.md list renders with correct numbering
• pre-commit run --files <changed> passes
• Every URL introduced resolves: repo (public, 200), Read the Docs (200)

[gemini-code-assist]

Code Review

This pull request updates the documentation across several files to clarify that the package is not published on PyPI and should instead be installed directly from the GitHub repository using pinned release tags. It also updates repository URLs and simplifies the contributing workflow. The review feedback recommends appending the ".git" suffix to the repository URLs in the installation commands for more robust VCS detection, and notes that removing the fork instructions from the contributing guide may block external contributors who lack direct write access.

[Copilot]

Pull request overview

Updates the project documentation to reflect how envars is actually consumed (via Git installs from this repository) and removes/cleans up misleading or broken public-facing docs references.

Changes:

• Replace incorrect PyPI install instructions with git+https://.../envars2@<tag> install examples (and add a uv add example).
• Remove the broken PyPI version badge and fix placeholder clone URLs (your-username → timeoutdigital/envars2).
• Update contributing guidance to reference the master default branch and mention the no-commit-to-branch hook.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
README.md	Removes broken PyPI badge; updates install instructions to Git-based install and fixes clone URL.
docs/getting-started.md	Fixes published docs to use the correct GitHub-based install flow.
docs/project/contributing.md	Updates contribution workflow text (branch target + hook note) and fixes clone URL.
docs/project/ARCHITECTURE.md	Replaces placeholder clone URL with the real repository URL.

Suppressed comments (1)

docs/project/contributing.md:42

• git push origin ... will fail for contributors who cloned the upstream repo but do not have write access. The instructions should clarify that origin only works for maintainers/outside-collaborators, and that others should push to their fork remote.

2.  **Push your branch** to GitHub: `git push origin my-feature-branch`

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.