Skip to content

docs: add logo and shields.io badges to README#17

Closed
maltsev-dev wants to merge 2 commits into
masterfrom
docs/logo-badges-classifiers
Closed

docs: add logo and shields.io badges to README#17
maltsev-dev wants to merge 2 commits into
masterfrom
docs/logo-badges-classifiers

Conversation

@maltsev-dev

Copy link
Copy Markdown
Member

Summary

Adds the NullRun logo and a set of shields.io badges to the top of README.md so the package page on PyPI renders the brand identity at a glance.

Changes

  • docs/nullrun-logo.png (new file, 325 KB) — the NullRun NR mark. Hosted in-repo so it is reachable from the rendered README on PyPI via raw.githubusercontent.com (HTTPS only — PyPI strips http images).
  • README.md — adds two badge rows at the top, above the existing heading:
    • Release: PyPI version, Python versions, License, Downloads
    • Quality/Project: CI, Coverage, Stars, Documentation

All badges link to the corresponding real page (PyPI, GitHub Actions, Codecov, docs.nullrun.io).

Diff scope

README.md             |  35 +++++++++++++++++++++++++++++++++++
docs/nullrun-logo.png | Bin 0 -> 325059 bytes

Why

  • PyPI currently renders only plain text. A logo + badges make the package discoverable and signal project health, matching how nullout-mcp and other ecosystem packages present themselves.
  • All badges are https:// only (PyPI readme-sanitiser requirement).

Out of scope

  • pyproject.toml classifiers — left as-is per project decision.
  • The @protect example form in README — kept exactly as on master.

analyze.md is a session-scoped working-notes file (~240 KB of
audit/plan material) that does not belong in the public SDK
repo. Remove from version control but keep on disk for the
author's reference.

- git rm --cached analyze.md: drop from index, file stays on disk
- add analyze.md to .gitignore so it isn't accidentally re-added
- drop the self-referential '.gitignore' entry from .gitignore
  so future edits don't need 'git add -f'
- Add docs/nullrun-logo.png (NullRun NR logo) and render it centered
  at the top of README.md via raw.githubusercontent.com
- Add shields.io badges in two rows:
  * Release: PyPI version, Python versions, License, Downloads
  * Quality/Project: CI, Coverage, Stars, Documentation
- All badges use https:// (PyPI readme sanitizer strips http://)
- No classifier changes (left as-is per project decision)
@maltsev-dev maltsev-dev deleted the docs/logo-badges-classifiers branch June 19, 2026 06:41
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