aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrett Parson <brett@brett-parson.com>2026-08-30 21:40:06 -0500
committerBrett Parson <brett@brett-parson.com>2026-08-30 21:40:06 -0500
commitc42dfaceb20d2303f23dfba4f1d8c2ff402c3d79 (patch)
tree6ae676616d17928830d268e8d88ede3fac13d9b7
parenta2b29fe6ffa16a0af5635505df7250f27724260a (diff)
downloadminiroute-c42dfaceb20d2303f23dfba4f1d8c2ff402c3d79.tar.gz
miniroute-c42dfaceb20d2303f23dfba4f1d8c2ff402c3d79.zip
Advertise Packagist as the install routeHEADmain
Update the README to composer require brettparson/miniroute, note the Packagist publication in the changelog and roadmap, and record the Packagist update step in the release flow.
-rw-r--r--AGENTS.md3
-rw-r--r--CHANGELOG.md3
-rw-r--r--README.md7
-rw-r--r--composer.json1
-rw-r--r--docs/roadmap.md4
5 files changed, 13 insertions, 5 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 47aa32b..8fa83e7 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -45,7 +45,8 @@ composer bench # registration/dispatch scaling benchmark (manual, not CI)
- Add a line under `[Unreleased]` for every user-facing change.
- Release: rename Unreleased to the version, bump `composer.json`, tag `vN.N.N`,
- push. See `CHANGELOG.md` header for the full convention.
+ push, then trigger a Packagist update (webhook or the Update button on the
+ package page). See `CHANGELOG.md` header for the full convention.
## Non-Interactive Shell Commands
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 111aaf6..0ab4a4d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,9 @@ How it works:
### Added
+- Published to [Packagist](https://packagist.org/packages/brettparson/miniroute);
+ install is now `composer require brettparson/miniroute:^0.1`.
+
- Integration suite (`tests/Integration/RealisticRouteTableTest.php`):
the 22-route brett-parson.com model, `/admin` group + POST-only CSRF
ordering, literal `preview` beating `{id}`, param injection, 5-layer
diff --git a/README.md b/README.md
index f5b75a5..e5ced97 100644
--- a/README.md
+++ b/README.md
@@ -13,13 +13,16 @@ without being a framework.
## Install
-### Via Composer (VCS repository)
+### Via Composer (Packagist)
```bash
-composer config repositories.miniroute vcs https://src.brett-parson.com/git/miniroute.git
composer require brettparson/miniroute:^0.1
```
+The package is published on
+[Packagist](https://packagist.org/packages/brettparson/miniroute); the canonical
+source is the [cgit repository](https://src.brett-parson.com/miniroute.git/).
+
### Via a local path repository (development)
```json
diff --git a/composer.json b/composer.json
index dcda42e..0950425 100644
--- a/composer.json
+++ b/composer.json
@@ -3,6 +3,7 @@
"description": "A small attribute-based routing and middleware kernel for PHP applications.",
"type": "library",
"license": "MIT",
+ "keywords": ["routing", "router", "middleware", "attributes", "php"],
"require": {
"php": ">=8.2"
},
diff --git a/docs/roadmap.md b/docs/roadmap.md
index fd2e698..52cfeaa 100644
--- a/docs/roadmap.md
+++ b/docs/roadmap.md
@@ -63,8 +63,8 @@ Gate: the realistic stress section passes against the real controllers.
- `18h.1` — API freeze review of the public surface (attributes, interfaces,
exceptions, `Router` methods).
-- `18h.2` — Dogfood via Composer: parsonwebsite consumes the package from the
- published VCS remote.
+- `18h.2` — Dogfood via Composer: parsonwebsite consumes `brettparson/miniroute`
+ from Packagist (already published at v0.1.0) as a versioned dependency.
- `18h.3` — CI benchmark gates: full-table registration < 5ms, dispatch
< 0.1ms, full suite green.
- `18h.4` — Tag `v1.0.0`, publish, strict-SemVer policy from here.