summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsiddharth ravikumar <s@ricketyspace.net>2022-06-04 21:37:45 -0400
committersiddharth ravikumar <s@ricketyspace.net>2022-06-04 21:37:45 -0400
commit9c59e10ef90d2b9aec40e7a23830efa3d8635142 (patch)
tree1ff8a6853385199a84a69b88b11206cba5cb23e5 /README.md
parentc4e922b80067d09796f2050b994f74420473a44f (diff)
README.md: add about building and running
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6007928..d5165c5 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,22 @@
# peach
A weather site.
+
+## building
+
+```bash
+make
+```
+
+## running
+
+```
+peach [ -p PORT ]
+```
+
+If the port is not given, it defaults to `8151`.
+
+### environment variables
+
+- `PEACH_PHOTON_URL`: Photon api url. Set this if geocoding should be
+ enabled.