aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1117ccd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# UMoSApi
+
+Unity Mongo Save Api is a simple API for save Unity object in Mongo database.
+
+# Dependencies
+
+Install all dependencies from the `src/requirement.txt` file.
+
+# Documentation
+
+Go in `src` folder and run `./launch-dev.sh`.
+
+The documentation is available here : [http://127.0.0.1:5000/api/doc](http://127.0.0.1:5000/api/doc).