From f41c8cec7cf1db2861968050ccc8d752286bc87e Mon Sep 17 00:00:00 2001
From: Nicholas Charriere
Date: Tue, 22 Oct 2024 13:00:06 -0700
Subject: [PATCH] Update README to talk about app builder (#408)
* Update README
* Dont use picture tags for npm
* Format readmes
---
README.md | 27 ++++++++++++++++++++++++---
srcbook/README.md | 23 ++++++++++++++++++++---
2 files changed, 44 insertions(+), 6 deletions(-)
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
+
+
+
+### 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