docs: rename project to Plexus and rewrite README#6
Conversation
Rebrand CoreMQ as Plexus — anatomical metaphor for a network of
nerves, mapping directly to the broker's role as a central junction
that everything routes through. CoreMQ was descriptive but generic;
Plexus is distinctive in the MQTT/messaging space.
This PR is README-only. The Cargo crate (coremq-server) and npm
package (coremq-dashboard) keep their current names for now; a
follow-up PR will rename the binary, package, and config paths.
README rewrite highlights:
- New tagline + opening that explains the architectural choice
behind the name (single Tokio engine, async channels).
- Lead with "At a glance" — seven bullets that cover the whole
feature surface in 10 seconds.
- Merge the redundant "MQTT Protocol Support" and "Multi-Transport
Support" sections.
- Architecture: keep the diagram, but the prose now explains why
the single-threaded engine choice matters (lock contention story).
- Performance and Security are paragraphs, not bullet lists.
Drop marketing phrases like "zero-cost abstractions" that don't
add information.
- Topic Monitoring & REST Publish: trimmed the long JSON sample,
kept the why-it-matters list and the curl examples.
- QoS claims rewritten to match reality: "QoS 0 in production,
QoS 1/2 wiring in progress." Removes the misleading
"expandable to QoS 1/2" phrasing.
- Roadmap: drop the WebSocket metrics endpoint (already shipped
and documented above).
- New Contributing section linking AGENTS.md, CONTRIBUTING.md,
and CHANGELOG.md.
- Honest callout that "Plexus" branding is ahead of the package
rename, so readers don't get confused by `coremq-server` in
build commands.
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Rename the project from CoreMQ to Plexus and rewrite the README around the new identity.
Plexus— anatomical term for a network of nerves (e.g. solar plexus, brachial plexus). Direct metaphor for what an MQTT broker does: act as the central junction that every signal routes through. Distinctive in the MQTT/messaging space, no major collisions, technical without being pretentious.This PR is README-only. The Cargo crate (
coremq-server), the npm package (coremq-dashboard), the config paths (/etc/coremq/), and the GitHub repo name are unchanged. A follow-up PR will handle the rename across code/config — kept separate so the rebrand decision can be reviewed independently of the mechanical renames.Why a separate name
CoreMQis technically accurate but generic —core+MQreads as a placeholder. Five other projects usecorein their messaging product name.Plexusis:MQsuffix needed — the architecture-as-name does the work.What's in the rewrite
Diff: +146 / −211 (357 → 305 lines, ~28% shorter, denser).
packet_idpanic fix (docs: add AGENTS, CONTRIBUTING, CHANGELOG, and skill playbooks #5 → ef67625) is part of the QoS 1/2 path, not full support.CONTRIBUTING.md,AGENTS.md,CHANGELOG.md. Note: those three files are added in docs: add AGENTS, CONTRIBUTING, CHANGELOG, and skill playbooks #5 — links resolve once both this PR and docs: add AGENTS, CONTRIBUTING, CHANGELOG, and skill playbooks #5 are onmain.coremq-serverin the build commands.Follow-up renames (separate PRs)
If the name lands well, the deferred mechanical changes are:
server/coremq-server/Cargo.toml→name = "plexus-server"(or"plexus"), update workspace members, fixcargo run -pinvocations across docs.client/package.json→"name": "plexus-dashboard"./etc/coremq/→/etc/plexus/,C:\ProgramData\CoreMQ\→C:\ProgramData\Plexus\. Migration shim or doc on how to move existing config.mqttRust/coremq_rust→mqttRust/plexus. GitHub redirects from the old name.Each of these is independently reversible. None block this PR.
Test plan
CoreMQreferences or broken links.make build/docker compose up -dflows still work — README doesn't change them.Notes
CONTRIBUTING.md/AGENTS.md/CHANGELOG.mdresolve when this lands.