docs: update readme to show examples of how to test and run the app

flohansen · Jun 10, 2024 · 0ec041b · 0ec041b
1 parent 8967d99
commit 0ec041b
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,5 +2,24 @@
 
 ![ci pipeline](https://github.com/flohansen/dasher-server/actions/workflows/main.yml/badge.svg)
 
+## How to
+
+### Run tests
+```
+make test
+```
+or
+```
+go test ./... -race
+```
+### Run server
+```
+make run
+```
+or
+```
+go run cmd/main.go
+```
+
 ## API Paths
 `GET` `/api/v1/toggles`: Get all toggles stored by the server