Skip to content

Rewrite the README in Markdown around install, usage and the fork story, and move the comparisons into the docs - #19

Merged
avgvi merged 1 commit into
masterfrom
docs/readme-rewrite
Oct 11, 2026
Merged

avgvi merged 1 commit into
masterfrom
docs/readme-rewrite

Conversation

@avgvi

@avgvi avgvi commented Oct 11, 2026

Copy link
Copy Markdown
Member

Replaces the 462-line reStructuredText README, which still opened with the 2016 pitch and an IPython benchmark transcript, with a 182-line Markdown README built around install, usage and the fork story.

  • Title and tagline, badges for PyPI, Python versions, CI, docs and license, and the fork notice as an alert box.
  • Install, four highlighted usage examples (Cache, memoize, FanoutCache, the Django setting with DISK, SafeDisk), a capability-based feature list, "Why this fork", a four-line migration recipe, documentation links, a six-row comparison table, contributing and security, license with the original author's credit kept.
  • The Comparisons section moves unchanged to a new docs/comparisons.rst (two stale cells updated), the 2016 testimonials are dropped, and docs/index.rst becomes a landing page of its own instead of including the README.
  • pyproject.toml points at README.md; the rstcheck tox environment and lint matrix entry go away, since they only checked the README and rstcheck cannot lint the Sphinx tree cleanly.

Verified: GitHub's Markdown API renders the alert, the table, the badges and the highlighted blocks; Sphinx builds with warnings as errors; the sdist carries the README as text/markdown and passes twine check --strict; doc8, docs, flake8 and the full suite (398 passed) pass on Python 3.12.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 diskcache-community | 🛠️ Build #35079696 | 📁 Comparing 1113827 against latest (dc53eef)

  🔍 Preview build  

3 files changed
+ comparisons.html
± development.html
± index.html

@avgvi
avgvi merged commit a3fa2f5 into master Oct 11, 2026
22 checks passed
@avgvi
avgvi deleted the docs/readme-rewrite branch October 11, 2026 22:33
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