From 210433598a3072ed0ade022a580ac4522e491c01 Mon Sep 17 00:00:00 2001
From: Ben Woodward <ben@bdw.to>
Date: Thu, 15 Jul 2021 08:49:13 -0700
Subject: Local development setup (#47)

---
 README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4d04b4b..5d4fe19 100644
--- a/README.md
+++ b/README.md
@@ -16,8 +16,25 @@ Run the official Docker image on http://localhost:8080
 make run
 ```
 
-Run the live-reload server on http://localhost:3000
+## Development
+
+1. Make sure you have `yarn` installed
+2. Run the live-reload server on http://localhost:3000
+   ```
+   make dev
+   ```
+
+This project uses [Prettier](https://prettier.io/) formatting and all pull requests must pass
+the automated lint checks prior to merging.
+
+Run the link check with:
+
+```
+npx prettier --check . '!**/*.min.{css,js}'
+```
+
+Rewrite the files to resolve any style issues with:
 
 ```
-make dev
+npx prettier --write . '!**/*.min.{css,js}'
 ```
-- 
cgit v1.2.3