diff --git a/README.md b/README.md index 40e5dd9b..d77c3170 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,36 @@ Youtube

+## Srcbook + +Srcbook is a TypeScript-centric app development platform. It allows you to create and iterate on web apps incredibly fast using AI as a pair-programmer. +It can create or edit web apps, and also write and execute backend code through an interactive notebook interface. + +Srcbook is open-source (apache2) and runs locally on your machine. You need to bring your own API key for AI usage (we strongly recommend Anthropic with `claude-3-5-sonnet-latest`). + ## Features -- Create, run, and share reproducible programs and ideas +### App Builder + +- AI app builder for TypeScript +- Create, edit and run web apps +- Use AI to generate the boilerplate, modify the code, and fix things +- Edit the app with a hot-reloading web preview + + + + + Example Srcbook + + +### Notebooks + +- Create, run, and share TypeScript notebooks - Export to valid markdown format (.src.md) - AI features for exploring and iterating on ideas - Diagraming with [mermaid](https://mermaid.js.org) for rich annotations - Local execution with a web interface - Powered by Node.js -- Open-source under the Apache2 license @@ -73,7 +94,7 @@ Options: Commands: start [options] Start the Srcbook server - import [options] Import a Srcbook + import [options] Import a Notebook help [command] display help for command ``` diff --git a/srcbook/README.md b/srcbook/README.md index 3b7d0404..ee99a8ee 100644 --- a/srcbook/README.md +++ b/srcbook/README.md @@ -11,17 +11,34 @@ Youtube

+## Srcbook + +Srcbook is a TypeScript-centric app development platform. It allows you to create and iterate on web apps incredibly fast using AI as a pair-programmer. +It can create or edit web apps, and also write and execute backend code through an interactive notebook interface. + +Srcbook is open-source (apache2) and runs locally on your machine. You need to bring your own API key for AI usage (we strongly recommend Anthropic with `claude-3-5-sonnet-latest`). + ## Features -- Create, run, and share reproducible programs and ideas +### App Builder + +- AI app builder for TypeScript +- Create, edit and run web apps +- Use AI to generate the boilerplate, modify the code, and fix things +- Edit the app with a hot-reloading web preview + +![example app builder app light](https://i.imgur.com/k4xAyCQ.png) + +### Notebooks + +- Create, run, and share TypeScript notebooks - Export to valid markdown format (.src.md) - AI features for exploring and iterating on ideas - Diagraming with [mermaid](https://mermaid.js.org) for rich annotations - Local execution with a web interface - Powered by Node.js -- Open-source under the Apache2 license -![Example Srcbook light](https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/ebfa2bfe-f805-4398-a348-0f48d4f93400/public) +![example notebook light](https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/ebfa2bfe-f805-4398-a348-0f48d4f93400/public) ## FAQ