Merge pull request #9 from dxw/update-README

Update README - Add setup steps
dxw · Sep 9, 2024 · 64d936a · 64d936a
2 parents 74c8973 + dabc3c7
commit 64d936a
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,13 @@
+# Towtruck
+
 Towtruck is an application to aid maintenence of dxw's repos. 
 It aims to make it easier to keep on top of which repos need updates applying.
 
+## Prerequisites
+
+You must have [nvm](https://github.com/nvm-sh/nvm) installed. It is available on brew.
+With `nvm` installed you should be able to run `scripts/setup` followed by `scripts/server` to run the application.
+
 
 ## Configuration