Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ packages/
scripts/
build-registry.ts Generates static registry JSON from corpus
validate-shaders.ts Validates all shader manifests
apps/web/ SolidJS web app (browse, search, AI submit)
apps/web/ SolidJS web app (browse, search, detail pages)
```

### How it works
Expand Down Expand Up @@ -45,6 +45,10 @@ npx @shaderbase/cli search --pipeline postprocessing --env r3f
# Add a shader to your project
npx @shaderbase/cli add gradient-radial --env r3f
npx @shaderbase/cli add gradient-radial --env three --dir src/shaders

# Submit a shader (creates a GitHub PR via AI analysis)
npx @shaderbase/cli submit "void main() { gl_FragColor = vec4(1.0); }"
npx @shaderbase/cli submit https://www.shadertoy.com/view/XsXXDn
```

### MCP (for AI agents)
Expand All @@ -60,7 +64,7 @@ Add to your Claude config:
}
```

Tools: `search_shaders(query, category, pipeline, environment, tags)` and `get_shader(name, environment)`
Tools: `search_shaders`, `get_shader`, and `submit_shader`

## Repository Map

Expand All @@ -71,13 +75,14 @@ Tools: `search_shaders(query, category, pipeline, environment, tags)` and `get_s
| `packages/cli/` | CLI package (`shaderbase` on npm) |
| `packages/mcp/` | MCP server (Cloudflare Worker) |
| `scripts/` | Build and validation scripts |
| `apps/web/` | Web app (browse, search, AI submit) |
| `apps/web/` | Web app (browse, search, detail pages) |
| `docs/` | Git contract, plans |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for the provenance bar and submission checklist.

Submissions can be made via:
- The web app at `/submit` (AI parses your GLSL, creates a PR)
- The CLI: `npx @shaderbase/cli submit <glsl-or-url>` (AI parses your GLSL, creates a PR)
- The MCP `submit_shader` tool (for AI agents)
- Direct pull request to the `shaders/` directory
Loading