From 499ee75c6a750bf8e0292d860992243bab92416c Mon Sep 17 00:00:00 2001
From: Josh Creek <8179928+jcreek@users.noreply.github.com>
Date: Wed, 10 Apr 2024 20:55:43 +0100
Subject: [PATCH] docs(*): Add local development instructions and hosting
 details

---
 README.md | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 27473b5..35712de 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# LivingDexTracker
+# Living Dex Tracker
 
-A web app to track completion of a living Pokédex
+A web app to track completion of a living Pokédex.
 
 ## Developing
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+Cloned the repository you can install the dependencies with `npm install`, and start a development server:
 
 ```bash
 npm run dev
@@ -13,6 +13,10 @@ npm run dev
 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.
+
+Once you have done this, you can seed the Pokédex data using the /api/seed endpoint. You will need to comment out the `return;` at the beginning of the `GET` function in `/src/routes/api/seed.ts` to do this. Make sure you remember to uncomment it afterwards.
+
 ## Building
 
 To create a production version:
@@ -23,6 +27,14 @@ npm run build
 
 You can preview the production build with `npm run preview`.
 
+## Hosting
+
+The app is hosted on [Netlify](https://www.netlify.com/) at [pokedex.jcreek.co.uk](https://pokedex.jcreek.co.uk/).
+
+The Pokédex data is stored in a [MongoDB](https://www.mongodb.com/) database hosted on [MongoDB Cloud](https://cloud.mongodb.com/).
+
+User authentication is handled by [Supabase Auth](https://supabase.com/auth).
+
 ## Dependencies
 
 The living dex tracker's sprite collection is taken from [pokesprite](https://github.com/msikma/pokesprite), which is licensed under [the MIT license](https://github.com/msikma/pokesprite/blob/master/LICENSE).