summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKjetil Orbekk <kjetil.orbekk@gmail.com>2015-10-13 21:03:59 -0400
committerKjetil Orbekk <kjetil.orbekk@gmail.com>2015-10-13 21:03:59 -0400
commitc32fae261c0991d7a1a4f81cfd28f736f812689e (patch)
tree804aaf17df311638b6dafd1fc73e979cbe075ef6 /README.md
parent225d5d135c95d611d4edddac4a3fb3d4d3c5c4b6 (diff)
Add documentation and license file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9269e51
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Photos Organizer
+
+This is a tool to manage local digital photos imported from a camera.
+
+## Usage
+
+In nginx.conf:
+
+```conf
+ server {
+ listen [::]:80;
+ root /path/to/photos-organizer/web;
+ index index.html;
+ server_name photos.mydomain;
+ location / {
+ try_files $uri $uri/ =404;
+ }
+ location /api/ {
+ proxy_pass http://photos.localhost:8081/;
+ }
+ }
+
+```
+
+In another shell:
+
+```
+stack build && ./run.sh
+```