From 3eb10a94521eb9ac8357be98d5dedc91935a772f Mon Sep 17 00:00:00 2001
From: Josh Creek <8179928+jcreek@users.noreply.github.com>
Date: Mon, 29 Apr 2024 20:21:22 +0100
Subject: [PATCH] docs(*): Create basic readme

---
 README.md | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index dc1747b..6d05c8d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,30 @@
-# SvelteKitSaasBoilerplate
-A SvelteKit boilerplate project for a SaaS
+# SvelteKit Saas Boilerplate
+
+A SvelteKit boilerplate project for a Software As A Service (SaaS) application, to get you started quickly.
+
+## Developing
+
+After you have cloned the repository you can install the dependencies with `npm install`, and start a development server:
+
+```bash
+npm run dev
+
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
+```
+
+An example `.env` file is provided in the repository. You will need to copy `.env.example` to `.env` and fill in the values with your own credentials.
+
+## Building
+
+To create a production version:
+
+```bash
+npm run build
+```
+
+You can preview the production build with `npm run preview`.
+
+## Hosting and Tech Stack
+
+This application is designed to run on [Netlify](https://www.netlify.com/) and uses [Supabase](https://supabase.io/) for database storage and user authentication ([Supabase Auth](https://supabase.com/auth)).