summary refs log tree commit diff homepage
path: root/README.md
diff options
context:
space:
mode:
authorNguyễn Gia Phong <mcsinyx@disroot.org>2022-05-31 15:24:35 +0900
committerNguyễn Gia Phong <mcsinyx@disroot.org>2022-05-31 15:24:35 +0900
commitc2cb66ad1830d1394c5d6c1dfa2e75ef7e23072b (patch)
treef95a3ae89ccc4e7f5c8cb6f023d055e422df479a /README.md
downloadphylactery-c2cb66ad1830d1394c5d6c1dfa2e75ef7e23072b.tar.gz
Draft web server skeleton
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5eb8e9c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Phylactery
+
+Phylactery is a web server rendering comic books directly from ZIP archives.
+
+## Hacking
+
+    PHYLACTERY_ADDRESS=:42069 go run main.go
+
+## Copying
+
+![AGPLv3](https://www.gnu.org/graphics/agplv3-155x51.png)
+
+Phylactery is free software: you can redistribute it and/or modify it
+under the terms of the GNU [Affero General Public License][agplv3] as
+published by the Free Software Foundation, either version 3 of the License,
+or (at your option) any later version.
+
+[agplv3]: https://www.gnu.org/licenses/agpl-3.0.html