From 592b86ce3e6c86e3d315a05cf716771fd54e61d4 Mon Sep 17 00:00:00 2001 From: Nicholas Charriere Date: Tue, 22 Oct 2024 12:12:02 -0700 Subject: [PATCH 1/3] Update README --- README.md | 28 +++++++++++++++++++++++++--- srcbook/README.md | 33 ++++++++++++++++++++++++++++++--- 2 files changed, 55 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 40e5dd9b..08c784b6 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,37 @@ 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 +95,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..05a8f08f 100644 --- a/srcbook/README.md +++ b/srcbook/README.md @@ -11,17 +11,44 @@ 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 -![Example Srcbook light](https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/ebfa2bfe-f805-4398-a348-0f48d4f93400/public) + + + + Example Srcbook + + ## FAQ From a47ed2feeb01d3df5da25ffa3f055ee2daa13bbb Mon Sep 17 00:00:00 2001 From: Nicholas Charriere Date: Tue, 22 Oct 2024 12:53:36 -0700 Subject: [PATCH 2/3] Dont use picture tags for npm --- srcbook/README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/srcbook/README.md b/srcbook/README.md index 05a8f08f..f742f242 100644 --- a/srcbook/README.md +++ b/srcbook/README.md @@ -28,11 +28,7 @@ Srcbook is open-source (apache2) and runs locally on your machine. You need to b - Use AI to generate the boilerplate, modify the code, and fix things - Edit the app with a hot-reloading web preview - - - - Example Srcbook - +![example app builder app light](https://i.imgur.com/k4xAyCQ.png) ### Notebooks @@ -43,11 +39,7 @@ Srcbook is open-source (apache2) and runs locally on your machine. You need to b - Local execution with a web interface - Powered by Node.js - - - - Example Srcbook - +![example notebook light](https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/ebfa2bfe-f805-4398-a348-0f48d4f93400/public) ## FAQ From 57c00abeb3b7f9264181428e4d783cdb3e338cc1 Mon Sep 17 00:00:00 2001 From: Nicholas Charriere Date: Tue, 22 Oct 2024 12:54:05 -0700 Subject: [PATCH 3/3] Format readmes --- README.md | 1 - srcbook/README.md | 2 -- 2 files changed, 3 deletions(-) diff --git a/README.md b/README.md index 08c784b6..d77c3170 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,6 @@ 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 diff --git a/srcbook/README.md b/srcbook/README.md index f742f242..ee99a8ee 100644 --- a/srcbook/README.md +++ b/srcbook/README.md @@ -16,7 +16,6 @@ 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 @@ -41,7 +40,6 @@ Srcbook is open-source (apache2) and runs locally on your machine. You need to b ![example notebook light](https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/ebfa2bfe-f805-4398-a348-0f48d4f93400/public) - ## FAQ See [FAQ](https://github.com/srcbookdev/srcbook/blob/main/FAQ.md).