summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0156eb0..30344de 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,15 @@
# Balalaika
Lyrics api written in rust (school project).
+## Deployment notes
+Deployment hasn't gone all that well and has needed
+a few changes to work correctly.
+These changes are not in the master branch.
+
+In order to access the documentation, go to niliara.net/balalaika/doc.
+From there you can also execute commands to the api.
+The main routes can still be accessed from niliara.net/balalaika.
+
## Setup
### Dependencies
This project requires mariadb and cargo.