Переглянути джерело

docs: add README quickstart install links (#1293)

Drew Ritter 4 місяців тому
батько
коміт
5745f0ea99
1 змінених файлів з 80 додано та 62 видалено
  1. 80 62
      README.md

+ 80 - 62
README.md

@@ -2,6 +2,10 @@
 
 
 Superpowers is a complete software development methodology for your coding agents, built on top of a set of composable skills and some initial instructions that make sure your agent uses them.
 Superpowers is a complete software development methodology for your coding agents, built on top of a set of composable skills and some initial instructions that make sure your agent uses them.
 
 
+## Quickstart
+
+Give your agent Superpowers: [Claude Code](#claude-code), [Codex CLI](#codex-cli), [Codex App](#codex-app), [Factory Droid](#factory-droid), [Gemini CLI](#gemini-cli), [OpenCode](#opencode), [Cursor](#cursor), [GitHub Copilot CLI](#github-copilot-cli).
+
 ## How it works
 ## How it works
 
 
 It starts from the moment you fire up your coding agent. As soon as it sees that you're building something, it *doesn't* just jump into trying to write code. Instead, it steps back and asks you what you're really trying to do. 
 It starts from the moment you fire up your coding agent. As soon as it sees that you're building something, it *doesn't* just jump into trying to write code. Instead, it steps back and asks you what you're really trying to do. 
@@ -26,112 +30,126 @@ Thanks!
 
 
 ## Installation
 ## Installation
 
 
-**Note:** Installation differs by platform. 
+Installation differs by harness. If you use more than one, install Superpowers separately for each one.
 
 
-### Claude Code Official Marketplace
+### Claude Code
 
 
 Superpowers is available via the [official Claude plugin marketplace](https://claude.com/plugins/superpowers)
 Superpowers is available via the [official Claude plugin marketplace](https://claude.com/plugins/superpowers)
 
 
-Install the plugin from Anthropic's official marketplace:
+#### Official Marketplace
+
+- Install the plugin from Anthropic's official marketplace:
 
 
-```bash
-/plugin install superpowers@claude-plugins-official
-```
+  ```bash
+  /plugin install superpowers@claude-plugins-official
+  ```
 
 
-### Claude Code (Superpowers Marketplace)
+#### Superpowers Marketplace
 
 
 The Superpowers marketplace provides Superpowers and some other related plugins for Claude Code.
 The Superpowers marketplace provides Superpowers and some other related plugins for Claude Code.
 
 
-In Claude Code, register the marketplace first:
+- Register the marketplace:
+
+  ```bash
+  /plugin marketplace add obra/superpowers-marketplace
+  ```
+
+- Install the plugin from this marketplace:
 
 
-```bash
-/plugin marketplace add obra/superpowers-marketplace
-```
+  ```bash
+  /plugin install superpowers@superpowers-marketplace
+  ```
 
 
-Then install the plugin from this marketplace:
+### Codex CLI
 
 
-```bash
-/plugin install superpowers@superpowers-marketplace
-```
+Superpowers is available via the [official Codex plugin marketplace](https://github.com/openai/plugins).
 
 
-### OpenAI Codex CLI
+- Open the plugin search interface:
 
 
-- Open plugin search interface
+  ```bash
+  /plugins
+  ```
 
 
-```bash
-/plugins
-```
+- Search for Superpowers:
 
 
-Search for Superpowers
+  ```bash
+  superpowers
+  ```
 
 
-```bash
-superpowers
-```
+- Select `Install Plugin`.
 
 
-Select `Install Plugin`
+### Codex App
 
 
-### OpenAI Codex App
+Superpowers is available via the [official Codex plugin marketplace](https://github.com/openai/plugins).
 
 
 - In the Codex app, click on Plugins in the sidebar.
 - In the Codex app, click on Plugins in the sidebar.
-- You should see `Superpowers` in the Coding section. 
+- You should see `Superpowers` in the Coding section.
 - Click the `+` next to Superpowers and follow the prompts.
 - Click the `+` next to Superpowers and follow the prompts.
 
 
+### Factory Droid
+
+- Register the marketplace:
+
+  ```bash
+  droid plugin marketplace add https://github.com/obra/superpowers
+  ```
+
+- Install the plugin:
 
 
-### Cursor (via Plugin Marketplace)
+  ```bash
+  droid plugin install superpowers@superpowers
+  ```
 
 
-In Cursor Agent chat, install from marketplace:
+### Gemini CLI
+
+- Install the extension:
+
+  ```bash
+  gemini extensions install https://github.com/obra/superpowers
+  ```
 
 
-```text
-/add-plugin superpowers
-```
+- Update later:
 
 
-or search for "superpowers" in the plugin marketplace.
+  ```bash
+  gemini extensions update superpowers
+  ```
 
 
 ### OpenCode
 ### OpenCode
 
 
 OpenCode uses its own plugin install; install Superpowers separately even if you
 OpenCode uses its own plugin install; install Superpowers separately even if you
 already use it in another harness.
 already use it in another harness.
 
 
-Tell OpenCode:
+- Tell OpenCode:
 
 
-```
-Fetch and follow instructions from https://raw.githubusercontent.com/obra/superpowers/refs/heads/main/.opencode/INSTALL.md
-```
+  ```
+  Fetch and follow instructions from https://raw.githubusercontent.com/obra/superpowers/refs/heads/main/.opencode/INSTALL.md
+  ```
 
 
-**Detailed docs:** [docs/README.opencode.md](docs/README.opencode.md)
+- Detailed docs: [docs/README.opencode.md](docs/README.opencode.md)
 
 
-### GitHub Copilot CLI
+### Cursor
 
 
-```bash
-copilot plugin marketplace add obra/superpowers-marketplace
-copilot plugin install superpowers@superpowers-marketplace
-```
+- In Cursor Agent chat, install from marketplace:
 
 
-### Gemini CLI
+  ```text
+  /add-plugin superpowers
+  ```
 
 
-```bash
-gemini extensions install https://github.com/obra/superpowers
-```
+- Or search for "superpowers" in the plugin marketplace.
 
 
-To update:
-
-```bash
-gemini extensions update superpowers
-```
-
-### Factory Droid
+### GitHub Copilot CLI
 
 
-In Droid, register the marketplace:
+- Register the marketplace:
 
 
-```bash
-droid plugin marketplace add https://github.com/obra/superpowers
-```
+  ```bash
+  copilot plugin marketplace add obra/superpowers-marketplace
+  ```
 
 
-Then install:
+- Install the plugin:
 
 
-```bash
-droid plugin install superpowers@superpowers
-```
+  ```bash
+  copilot plugin install superpowers@superpowers-marketplace
+  ```
 
 
 ## The Basic Workflow
 ## The Basic Workflow