Skip to content

Commit 3f96db8

Browse files
committed
docs: update README to reflect flat root structure
1 parent c28c507 commit 3f96db8

1 file changed

Lines changed: 33 additions & 13 deletions

File tree

README.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,41 @@
11
# Supabase Plugin
22

3-
The official Supabase plugin for AI coding assistants. One plugin, distributed to all supported platforms simultaneously.
3+
The official Supabase plugin for AI coding assistants. One repo, distributed to all supported platforms simultaneously.
44

55
## Supported Platforms
66

7-
| Platform | Package | Install |
8-
|---|---|---|
9-
| [Claude Code](https://claude.ai/code) | [`packages/claude-code`](packages/claude-code) | |
10-
| [Cursor](https://cursor.com) | [`packages/cursor`](packages/cursor) | |
11-
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | [`packages/gemini`](packages/gemini) | `gemini extensions install https://github.com/supabase-community/supabase-plugin` |
12-
| [Codex](https://codex.openai.com) | [`packages/codex`](packages/codex) | |
7+
| Platform | Install |
8+
|---|---|
9+
| [Claude Code](https://claude.ai/code) | See [docs/claude-code.md](docs/claude-code.md) |
10+
| [Cursor](https://cursor.com) | See [docs/cursor.md](docs/cursor.md) |
11+
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | `gemini extensions install https://github.com/supabase-community/supabase-plugin` |
12+
| [Codex](https://openai.com/codex) | See [docs/codex.md](docs/codex.md) |
1313

1414
## What's Included
1515

16-
Each platform package contains:
16+
- **MCP Server** (`mcp.json`) — Remote connection to the [Supabase MCP server](https://supabase.com/mcp) for project management, SQL execution, migrations, and more
17+
- **Skills** (`skills/`) — Agent skills from [supabase/agent-skills](https://github.com/supabase/agent-skills):
18+
- `supabase` — General Supabase guidance for Auth, Storage, Edge Functions, Realtime, and more
19+
- `supabase-postgres-best-practices` — Postgres performance optimization and schema best practices
20+
- **Gemini Extension** (`gemini-extension.json`) — Gemini CLI extension manifest
21+
- **Context** (`SUPABASE.md`) — Shared context file loaded by Gemini and other platforms
1722

18-
- **MCP Server** — Remote connection to the [Supabase MCP server](https://supabase.com/mcp) for project management, SQL execution, migrations, and more
19-
- **Skills** — Agent skills from [supabase/agent-skills](https://github.com/supabase/agent-skills) including `supabase` and `supabase-postgres-best-practices`
23+
## Repository Structure
24+
25+
```
26+
supabase-plugin/
27+
├── mcp.json # MCP server config (mcpServers wrapper format)
28+
├── gemini-extension.json # Gemini CLI extension manifest
29+
├── SUPABASE.md # Shared context loaded by Gemini
30+
├── assets/
31+
│ └── logo.svg
32+
├── skills/ # Symlink → submodules/agent-skills/skills/supabase*
33+
│ ├── supabase/
34+
│ └── supabase-postgres-best-practices/
35+
├── submodules/
36+
│ └── agent-skills/ # git submodule: github.com/supabase/agent-skills
37+
└── docs/ # Per-platform install guides
38+
```
2039

2140
## Development
2241

@@ -25,6 +44,7 @@ This repo uses a git submodule for shared agent skills.
2544
After cloning, initialize the submodule:
2645

2746
```bash
47+
git clone https://github.com/supabase-community/supabase-plugin
2848
git submodule update --init --recursive
2949
```
3050

@@ -38,10 +58,10 @@ git commit -m "chore: update agent-skills submodule"
3858

3959
## Releasing
4060

41-
This repo uses [Release Please](https://github.com/googleapis/release-please) for automated releases. A single release bumps the version in all four platform packages simultaneously.
61+
This repo uses [Release Please](https://github.com/googleapis/release-please) for automated releases.
4262

43-
1. Merge commits with `feat:` or `fix:` prefixes to trigger a release
44-
2. Release Please opens a release PR with version bump and changelog
63+
1. Merge commits with `feat:` or `fix:` prefixes to trigger a release PR
64+
2. Release Please opens a PR with version bump and changelog
4565
3. Merge the release PR to publish
4666
4. Four platform archives are uploaded to the GitHub release:
4767
- `supabase-claude-code-plugin.tar.gz`

0 commit comments

Comments
 (0)