diff --git a/README.md b/README.md index 772924d..635c1a2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,25 @@ +

+ + + + + OpenCode SRD Framework by Dojo Coding: Build backwards from success + + +

+ # OpenCode SRD Framework +**The SRD methodology for OpenCode, installed with one npm command, for builders who want to know what to build next.** + Synthetic Reality Development (SRD) for OpenCode. This package installs global commands, agents, and skills, and registers an npm-loaded OpenCode plugin that nudges teams back toward revenue-critical work after edits. This package is the OpenCode-compatible npm distribution of the upstream SRD framework in [`DojoCodingLabs/srd-framework`](https://github.com/DojoCodingLabs/srd-framework). The upstream project targets Claude Code's plugin marketplace flow, while this repo repackages the same SRD methodology and assets for OpenCode and npm-based installation. +[![npm version](https://img.shields.io/npm/v/@dojocoding/opencode-srd-framework?color=FF7151&labelColor=201E3D)](https://www.npmjs.com/package/@dojocoding/opencode-srd-framework) [![License MIT](https://img.shields.io/badge/license-MIT-FF7151?labelColor=201E3D)](LICENSE) ![OpenCode plugin](https://img.shields.io/badge/OpenCode-plugin-201E3D?labelColor=201E3D) + +[Get started](#install) · [Commands](#available-commands) · [Compatibility](#compatibility-notes) · [Migrating from Claude Code](docs/migration-from-claude-code.md) · [Report an issue](https://github.com/DojoCodingLabs/opencode-srd-framework/issues/new) + ## What SRD Is SRD is a backwards-from-success product workflow: @@ -120,3 +136,11 @@ More detail: - `docs/migration-from-claude-code.md` - `docs/compatibility.md` - `docs/release.md` + +## License + +[MIT](LICENSE). Built by [Dojo Coding](https://dojocoding.io). + +

+ Dojo Coding +

diff --git a/docs/assets/README.md b/docs/assets/README.md new file mode 100644 index 0000000..fdb53a2 --- /dev/null +++ b/docs/assets/README.md @@ -0,0 +1,9 @@ +# Banner + +`banner-light.svg` and `banner-dark.svg` are generated from `banner.toml` with +[dojo-readme-kit](https://github.com/DojoCodingLabs/.github/tree/main/kit), in the +[dojocoding.io](https://dojocoding.io) visual system. To change the banner, edit `banner.toml` and run: + + uvx --from "git+https://github.com/DojoCodingLabs/.github#subdirectory=kit" dojo-banner docs/assets/banner.toml + +`dojocoding-mark.png` is the official Dojo Coding mark, used in the README footer. diff --git a/docs/assets/banner-dark.svg b/docs/assets/banner-dark.svg new file mode 100644 index 0000000..eeb2385 --- /dev/null +++ b/docs/assets/banner-dark.svg @@ -0,0 +1 @@ +OpenCode SRD Framework by Dojo Coding: Build backwards from success diff --git a/docs/assets/banner-light.svg b/docs/assets/banner-light.svg new file mode 100644 index 0000000..30d910f --- /dev/null +++ b/docs/assets/banner-light.svg @@ -0,0 +1 @@ +OpenCode SRD Framework by Dojo Coding: Build backwards from success diff --git a/docs/assets/banner.toml b/docs/assets/banner.toml new file mode 100644 index 0000000..d9f8c9b --- /dev/null +++ b/docs/assets/banner.toml @@ -0,0 +1,12 @@ +name = "OpenCode SRD Framework" +tagline = "Build [backwards] from success" +chips = ["3 commands / 3 agents"] +meta = "Open source · OpenCode" +tile = "/" + +[card] +kind = "terminal" +label = "OpenCode" +status = "v0.1.1 · MIT" +lines = ["opencode-srd-framework install", "/srd-quick", ["/srd-generate", "docs/prd.md"]] +dim = "personas · journeys · gap audit" diff --git a/docs/assets/dojocoding-mark.png b/docs/assets/dojocoding-mark.png new file mode 100644 index 0000000..02e9446 Binary files /dev/null and b/docs/assets/dojocoding-mark.png differ