From b3b87633aac4ec7570fe0fe05d50fccf98ebe3af Mon Sep 17 00:00:00 2001
From: Jordan Welch <jordanhwelch@gmail.com>
Date: Thu, 11 Apr 2024 23:09:59 -0500
Subject: [PATCH] update README

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/README.md b/README.md
index f0bcd94..7d05c9d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,49 @@
 # games.wowellworld.com
 
 Simple Vue app for linking to daily games in one place.
+
+## Install
+
+```bash
+npm install
+```
+
+## Development
+
+```bash
+npm run dev
+```
+
+## Generate PWA Assets
+
+This will generate all proper asset icons for the PWA. The source icon is located at `public/icon.svg`.
+
+```bash
+npm run generate-pwa-assets
+```
+
+## Build for Production
+
+This site is automatically deployed to GitHub Pages using [GitHub Actions](./.github/workflows/deploy.yml).
+
+It can be manually built to the `dist` directory using
+
+```bash
+npm run build
+```
+
+## Testing
+
+```bash
+npm run test
+```
+
+## Linting & Fixing
+
+```sh
+npm run lint
+```
+
+```sh
+npm run fix
+```