Skip to content

Commit d8dd654

Browse files
committed
docs: rewrite README
1 parent 2303457 commit d8dd654

File tree

1 file changed

+42
-9
lines changed

1 file changed

+42
-9
lines changed

README.md

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,61 @@
11
# ClawdHub
22

3-
Minimal skill registry powered by TanStack Start + Convex.
3+
<p align="center">
4+
<a href="https://github.com/clawdbot/clawdhub/actions/workflows/ci.yml?branch=main"><img src="https://img.shields.io/github/actions/workflow/status/clawdbot/clawdhub/ci.yml?branch=main&style=for-the-badge" alt="CI status"></a>
5+
<a href="https://discord.gg/clawd"><img src="https://img.shields.io/discord/1456350064065904867?label=Discord&logo=discord&logoColor=white&color=5865F2&style=for-the-badge" alt="Discord"></a>
6+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" alt="MIT License"></a>
7+
</p>
48

5-
## Quick start
9+
ClawdHub is the **public skill registry for Clawdbot**: publish, version, and search text-based agent skills (a `SKILL.md` plus supporting files).
10+
It’s designed for fast browsing + a CLI-friendly API, with moderation hooks and vector search.
11+
12+
Live: `https://clawdhub.com`
13+
14+
## What you can do
15+
16+
- Browse skills + render their `SKILL.md`.
17+
- Publish new versions with changelogs + tags (including `latest`).
18+
- Search via embeddings (vector index) instead of brittle keywords.
19+
- Star + comment; admins/mods can curate and approve.
20+
21+
## How it works (high level)
22+
23+
- Web app: TanStack Start (React, Vite/Nitro).
24+
- Backend: Convex (DB + file storage + HTTP actions) + Convex Auth (GitHub OAuth).
25+
- Search: OpenAI embeddings (`text-embedding-3-small`) + Convex vector search.
26+
- API schema + routes: `packages/schema` (`clawdhub-schema`).
27+
28+
## Repo layout
29+
30+
- `src/` — TanStack Start app (routes, components, styles).
31+
- `convex/` — schema + queries/mutations/actions + HTTP API routes.
32+
- `packages/schema/` — shared API types/routes for the CLI and app.
33+
- `docs/spec.md` — product + implementation spec (good first read).
34+
35+
## Local dev
36+
37+
Prereqs: Bun + Convex CLI.
638

739
```bash
840
bun install
941
cp .env.local.example .env.local
10-
bun --bun run dev
11-
```
1242

13-
In another terminal:
43+
# terminal A: web app
44+
bun run dev
1445

15-
```bash
46+
# terminal B: Convex dev deployment
1647
bunx convex dev
1748
```
1849

19-
## Convex Auth setup
50+
## Auth (GitHub OAuth) setup
51+
52+
Create a GitHub OAuth App, set `AUTH_GITHUB_ID` / `AUTH_GITHUB_SECRET`, then:
2053

2154
```bash
2255
bunx auth --deployment-name <deployment> --web-server-url http://localhost:3000
2356
```
2457

25-
This writes `JWT_PRIVATE_KEY` + `JWKS` to the deployment and prints the values for local `.env.local`.
58+
This writes `JWT_PRIVATE_KEY` + `JWKS` to the deployment and prints values for your local `.env.local`.
2659

2760
## Environment
2861

@@ -32,7 +65,7 @@ This writes `JWT_PRIVATE_KEY` + `JWKS` to the deployment and prints the values f
3265
- `SITE_URL`: App URL (local: `http://localhost:3000`).
3366
- `AUTH_GITHUB_ID` / `AUTH_GITHUB_SECRET`: GitHub OAuth App.
3467
- `JWT_PRIVATE_KEY` / `JWKS`: Convex Auth keys.
35-
- `OPENAI_API_KEY`: embeddings.
68+
- `OPENAI_API_KEY`: embeddings for search + indexing.
3669

3770
## Scripts
3871

0 commit comments

Comments
 (0)