doc: update readme

ianbayne · Mar 30, 2024 · 67607ea · 67607ea
1 parent e205637
commit 67607ea
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,12 @@
-Run the app with `foreman start -f Procfile.dev`. This will start both the server as well as the Sidekiq worker 
+# Wishly
+
+Still a work in progress.
+
+## Running the app locally
+
+Run the app with `foreman start -f Procfile.dev`. This will start both the server as 
+well as the Sidekiq worker.
+
+## Running tests
+
+To run the entire test suite, first install all required gems with `bundle install` and run `bundle exec rspec`.