summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhref <href@random.sh>2018-01-31 20:36:42 +0100
committerhref <href@random.sh>2018-01-31 20:36:42 +0100
commitfcb2a082346054108f3f16cffe968450cf961976 (patch)
tree8e7d2eb9eeebf854e62e08c29b147f34dfeb1881 /README.md
import
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..574f910
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# LSG
+
+## What
+
+ * Provides a small API on top of Icecast status page
+
+## Development
+
+To start your Phoenix server:
+
+ * Install dependencies with `mix deps.get`
+ * Start Phoenix endpoint with `mix phx.server`
+
+Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
+
+Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment).
+
+## Production
+
+Build a release using `MIX_ENV=prod mix release`.
+