Skip to content

Commit 13afa51

Browse files
docs: rebuild the README, with a hero, and proper attribution (#20)
* docs: rewrite the README around what Redcode is The README described install, dev, and release mechanics but never said what the project is or why the fork exists — a reader could not tell Redcode from OpenCode with a rename. Rewrite it around the actual product: the surfaces you can run, the Workers fleet console, the runtime decisions that distinguish this fork (Effect kernel with Location scoping, durable SessionV2 admission, reversible Cordis plugin profiles, System Context as data), and the dependency direction that reviews enforce. Every claim is checked against the code: command descriptions come from their `describe` strings, the native target list from the build script, the dependency rules from AGENTS.md, and the release steps from red-publish.yml. * docs: name the opencode/Redcode split and the v2 status A reader hits two surprises the first draft did not prepare them for: the source says OpenCode almost everywhere while the product says Redcode, and large parts of the v2 runtime are deliberately unfinished. Add a short naming note, a Status section listing what is shipped and what is explicitly deferred (crash recovery, clustering, workspace placement, client API stabilization, dynamic plugins), the TUI's SDK-only boundary, the packages that are not the product, and the CI contract that keeps the single-artifact posture honest. * docs: credit OpenCode and DeepSeek Harness properly The README framed OpenCode as merely "upstream" and never mentioned DeepSeek Harness at all, despite the runtime's composition model coming straight from it and @deepseek-ai/cordis being a real dependency of Core. Replace the terse Upstream section with Lineage, naming what each project actually gave us: OpenCode's agent loop, providers, tools, LSP plumbing, and TUI foundation; the Harness's reversible-ownership model, ordered activation, package-owned invariants, and real-entry testing discipline, plus its post-mortems and Cordis. Reframe the opening so the fork reads as building on good work rather than replacing it, and explain that keeping OpenCode's internal names is a deliberate choice to stay legible against theirs. * docs: rebuild the README in the red-skills mold Follow the structure that worked for red-skills: a hero, badges, a positioning line, attribution up front pointing at NOTICE, a Contents block, and one distinction that organizes everything after it. For Redcode that distinction is what ships versus what does not — the repo inherits a monorepo far larger than the product, and telling the two apart is the fastest way to read it. The core sections lead with the Session model, since durable admission before execution is the property the rest of the runtime is built around. Adds docs/hero.svg and a NOTICE carrying the OpenCode fork attribution, the DeepSeek Harness composition model, and Cordis — whose copyright is Shigma's, not DeepSeek's, which the license text confirms. * docs(opencode): give the npm package a real page The registry page for @reddb-io/redcode was two lines written inline by publish.ts — install command, nothing else. Anyone finding the package on npm learned nothing about what it is. Write a proper page there instead: what Redcode is, the platforms the binary covers, a table of the commands worth knowing, a link to the repository, and credit to OpenCode and DeepSeek Harness. The tarball now ships NOTICE next to LICENSE so the attribution travels with the package. It stays generated rather than copied from the repository README, whose hero image and relative links only resolve on GitHub.
1 parent 7b8733f commit 13afa51

5 files changed

Lines changed: 516 additions & 16 deletions

File tree

‎.changeset/npm-package-page.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"opencode": patch
3+
---
4+
5+
Publish a real npm package page: what Redcode is, how to install it, the commands you can run, and attribution to OpenCode and DeepSeek Harness. The tarball now also carries NOTICE alongside LICENSE.

‎NOTICE‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
redcode
2+
Copyright 2026 reddb.io
3+
4+
This product is licensed under the MIT License (see LICENSE).
5+
6+
Redcode is a fork of OpenCode (https://github.com/anomalyco/opencode), which is
7+
licensed under the MIT License. The overwhelming majority of this repository is
8+
their work — the agent loop, provider and model integration, the tool system,
9+
LSP and formatter support, and the terminal UI foundation. The upstream
10+
copyright notice is preserved verbatim in LICENSE:
11+
12+
MIT License
13+
Copyright (c) 2025 opencode
14+
15+
Permission is hereby granted, free of charge, to any person obtaining a copy
16+
of this software and associated documentation files (the "Software"), to deal
17+
in the Software without restriction, including without limitation the rights
18+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
19+
copies of the Software, and to permit persons to whom the Software is
20+
furnished to do so, subject to the following conditions:
21+
22+
The above copyright notice and this permission notice shall be included in all
23+
copies or substantial portions of the Software.
24+
25+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31+
SOFTWARE.
32+
33+
Redcode keeps OpenCode's internal package names (@opencode-ai/*), environment
34+
variable prefixes (OPENCODE_*), and module layout deliberately, so that changes
35+
made here stay readable against upstream.
36+
37+
Redcode's runtime composition model is adapted from DeepSeek Harness
38+
(https://github.com/deepseek-ai/deepseek-harness): reversible plugin ownership,
39+
ordered and awaited profile activation, transactional replacement with rollback,
40+
package-owned runtime invariants executed at boot readiness, and the practice of
41+
proving semantic outcomes through real entry points. The audit that decided what
42+
to adopt, adapt, and reject is recorded in .red/adr/0001 and in three research
43+
reports under .red/researches/.
44+
45+
This product depends on @deepseek-ai/cordis, licensed under the MIT License.
46+
Cordis is an independent plugin framework created by Shigma; DeepSeek vendors and
47+
maintains this build inside the deepseek-harness repository at vendor/cordis. The
48+
copyright is Shigma's:
49+
50+
MIT License
51+
Copyright (c) 2021-present Shigma
52+
53+
Permission is hereby granted, free of charge, to any person obtaining a copy
54+
of this software and associated documentation files (the "Software"), to deal
55+
in the Software without restriction, including without limitation the rights
56+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
57+
copies of the Software, and to permit persons to whom the Software is
58+
furnished to do so, subject to the following conditions:
59+
60+
The above copyright notice and this permission notice shall be included in all
61+
copies or substantial portions of the Software.
62+
63+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
64+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
65+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
66+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
67+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
68+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
69+
SOFTWARE.
70+
71+
Redcode integrates with RedSkills and the redskilled execution daemon
72+
(https://github.com/reddb-io/red-skills), which is reddb.io work licensed under
73+
Apache-2.0 and is not bundled here.
74+
75+
Neither the OpenCode project nor DeepSeek endorses Redcode. Report Redcode
76+
issues at https://github.com/reddb-io/redcode/issues.

0 commit comments

Comments
 (0)