add readme

cb65c6be · Fence · 343fd631 · cb65c6be
Commit cb65c6be authored Apr 22, 2020 by Fence 🌈
Hide whitespace changes
Inline Side-by-side

Showing with 18 additions and 0 deletions

ReadMe.md ReadMe.md +18 -0

No files found.
--- a/ReadMe.md
+++ b/ReadMe.md
+# Minor
+
+This is a small webservice that is part of the prismriver project.
+
+## requirements
+- mongodb
+
+## getting started
+This project uses [pipenv](https://pipenv.kennethreitz.org).
+
+To run the project, first install dependencies:
+```bash
+pipenv install --dev
+```
+Then run the serve script:
+```bash
+pipenv run serve
+```