From 11b9280a515a3c8572a685e7a0b59ea2dcc3e42d Mon Sep 17 00:00:00 2001
From: Roman Godmaire <godmaire@twilit.io>
Date: Sun, 19 Nov 2023 20:23:17 -0500
Subject: [PATCH] docs: Basic README update

---
 README.md | 41 +++++++++++++++++++++--------------------
 1 file changed, 21 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 5c91169..b30d8f0 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,39 @@
-# create-svelte
+# Larson
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+A way for music producers to get feedback on different versions of their music tracks.
 
-## Creating a project
+## Deploying
 
-If you're seeing this, you've probably already done this step. Congrats!
-
-```bash
-# create a new project in the current directory
-npm create svelte@latest
-
-# create a new project in my-app
-npm create svelte@latest my-app
-```
+TODO.
 
 ## Developing
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+1. Setup a `.env` file using the following template:
+
+```env
+DATABASE_URL="file:dev.db"
+S3_ENDPOINT="http://localhost:4566"
+S3_BUCKET="larsen-dev"
+```
+
+2. Run `pnpm install`
+3. Run `pnpx prisma db push`
+4. Setup an S3-compatible service for audio file storage
+5. Start the development server:
 
 ```bash
-npm run dev
+pnpm run dev
 
 # or start the server and open the app in a new browser tab
-npm run dev -- --open
+pnpm run dev -- --open
 ```
 
 ## Building
 
-To create a production version of your app:
+To create a production version of the app:
 
 ```bash
-npm run build
+pnpm 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.
+You can preview the production build with `pnpm run preview`.