Skip to content

Commit 09bffa5

Browse files
committed
docs: update site README for external API
1 parent 4071dbf commit 09bffa5

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,28 @@ Built with the **NOIR design system** - a terminal-aesthetic design language fea
1414

1515
## πŸ›  Tech Stack
1616

17-
- **Framework**: Next.js 14 (Static Site Generation)
17+
- **Framework**: Next.js 15 (Static Site Generation)
1818
- **Language**: TypeScript 5.x (strict mode)
1919
- **Styling**: Tailwind CSS 3.4+
2020
- **Fonts**: JetBrains Mono, Inter
21-
- **Package Manager**: pnpm
21+
- **Package Manager**: Bun
2222
- **Deployment**: GitHub Pages
23+
- **Playground Exports**: External API (`omniscript-api`)
2324

2425
## πŸš€ Development
2526

2627
```bash
2728
# Install dependencies
28-
pnpm install
29+
bun install
2930

3031
# Start development server
31-
pnpm run dev
32+
bun run dev
3233

3334
# Build for production
34-
pnpm run build
35+
bun run build
3536

3637
# Preview production build
37-
pnpm run start
38+
bun run start
3839
```
3940

4041
Visit `http://localhost:3000` to see the site.
@@ -57,6 +58,13 @@ omniscript-site/
5758
└── deploy.yml # GitHub Pages deployment
5859
```
5960

61+
## πŸ”Œ Playground Exports
62+
63+
Playground export buttons call a separate backend API service. Set the API base URL via
64+
`NEXT_PUBLIC_OSF_API_BASE` (see `.env.production`).
65+
66+
The backend code now lives in a separate private repo: `OmniScriptOSF/omniscript-api`.
67+
6068
## 🌐 Deployment
6169

6270
The site automatically deploys to GitHub Pages on every push to `main` branch.

0 commit comments

Comments
Β (0)