Update README.md

README.md

@@ -1,38 +1,39 @@
-# create-svelte
+# ComfyBox
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+An alternative UI to the backend server of the Stable Diffusion webapp [ComfyUI](https://github.com/comfyanonymous/ComfyUI). Build your workflow in a graph structure and have a custom Stable Diffusion interface created for you automatically.
 
-## Creating a project
+This project is *still under construction* and many features are missing, be aware of the tradeoffs if you're interested in using it.
 
-If you're seeing this, you've probably already done this step. Congrats!
+## NOTE
 
-```bash
+This frontend isn't compatible with regular ComfyUI's workflow format since extra metadata is saved like panel layout, so you'll have to spend a bit of time recreating them. This project also isn't compatible with regular ComfyUI's frontend extension format, but useful extensions can be integrated into this repo with some effort.
-# create a new project in the current directory
-npm create svelte@latest
 
-# create a new project in my-app
+## Proposed Features
-npm create svelte@latest my-app
+- All the power of ComfyUI with more convenience on top
+- Autocreation of UI widgets from your workflow, quickly creating a personalized dashboard
+- Custom widget and node types
+- Look up queued and finished generations and their configs in realtime
+- Development with TypeScript
+
+## Requirements
+
+- `pnpm`
+- [Turborepo](https://turbo.build/repo/docs/installing)
+- An installation of vanilla [ComfyUI](https://github.com/comfyanonymous/ComfyUI) for the backend
+
+## Installation
+
+1. Clone the repo with submodules:
+
+```
+git clone https://github.com/space-nuko/ComfyBox
 ```
 
-## Developing
+2. `pnpm install`
+3. `pnpm dev`
+4. Start ComfyUI as usual with `python main.py --enable-cors-header`
+5. Visit `http://localhost:3000` in your browser
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+## Screenshot (WIP)
 
-```bash
+![Screenshot](./static/screenshot.png)
-npm run dev
-
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
-
-## Building
-
-To create a production version of your app:
-
-```bash
-npm run build
-```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.