Update the public pages to 0.3.1

2026-10-07 08:10:26 +00:00
parent 3d0b59c424
commit 7aa7eb117b
9 changed files with 272 additions and 8 deletions
@@ -1,11 +1,39 @@
-# Nolimit Cache — release feed
+# Nolimit Cache

-Built zips only. The source lives in `kw/nolimit-cache`, which is private.
+![Nolimit Cache — the Overview screen](assets/hero.png)

-This repository is **public on purpose**: every WordPress site running the
-plugin asks it for updates, and it never sends credentials. A private feed
-answers 404 and the update simply never appears — no error on the site, no
-entry in the plugins list.
+A page cache and front-end optimiser for WordPress and WooCommerce. It answers
+a visitor's request from a file on disk before WordPress boots, and it knows
+enough about WooCommerce not to do that to a customer holding a basket. WebP
+and AVIF copies of your images, Redis object cache, preloading and a set of
+health checks are in the same plugin — with **nothing leaving the site**. No
+account, no licence check, no telemetry.

-Nothing here is edited by hand. Each release is published by the tag job in
-the source repository.
+## Install
+
+1. Download `nolimit-cache.zip` from the [latest release](https://gitea.nolimit.dk/kw/nolimit-cache-dist/releases/latest).
+2. **Plugins → Add New → Upload Plugin**, then activate.
+3. Open **Nolimit → Cache** and let the setup walk you through it — [the setup
+   guide](docs/SETUP.md) explains what it changes and how to tell it is working.
+
+Later versions arrive in **Dashboard → Updates** like any other plugin.
+
+## Documentation
+
+- [Overview](docs/README.md) — what it does, and what it deliberately does not
+- [Installing it, and telling whether it works](docs/SETUP.md) — the settings
+  that need a decision, images in WebP and AVIF, and how to check the cache is
+  really serving
+- [Hooks and integration](docs/CONTRACT.md) — for developers: what the plugin
+  offers to other plugins and to your own code
+
+## More of it
+
+| | |
+|---|---|
+| ![Page cache settings](assets/screenshots/page-cache.png) | **Page cache.** How long a page lives, what is never cached whatever you set, and separate copies for phones or signed-in visitors only if you ask for them. |
+| ![Images](assets/screenshots/images.png) | **Images.** WebP and AVIF copies written beside your JPEG and PNG files and offered to the browsers that understand them. Originals are never changed. |
+| ![WooCommerce settings](assets/screenshots/woocommerce.png) | **WooCommerce.** The basket, checkout and account pages are never cached, and a product page is cleared when its stock or an order changes. |
+| ![Tools](assets/screenshots/tools.png) | **Tools.** What it has installed in `wp-content`, written out plainly, and a button to write it again. |
+
+Requires WordPress 6.0+ and PHP 7.4+. WooCommerce is optional.