aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorubq323 <ubq323@ubq323.website>2022-01-20 21:12:37 +0000
committerubq323 <ubq323@ubq323.website>2022-01-20 21:12:37 +0000
commit3fdb818134d494027c75fd3bd3d32a5f4af62d41 (patch)
tree4a9413a63c7dd3f2f37f9d662248d2d5770c3ded /README.md
parent06bf507f13ec3891d5a567c64d1c02c970902109 (diff)
add readme and license (agpl3)
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..741b533
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# apioforum
+web forum software made for some specific use cases but probably generally
+usable as just a forum.
+
+currently missing a few features and has quite a few rough edges. i would not
+recommend that people use this in production, but if you did it would probably
+be ok.
+
+the "official" live instance is at <https://a.gh0.pw/>
+
+## usage
+however you prefer to deploy flask applications. `flask migrate` will set
+up the database for you.
+
+## community
+irc: `#a` on [APIONET](https://apionet.gh0.pw) (or anything bridged to it).
+note that this is a general discussion channel and isn't apioforum-specific.
+
+## contributing
+contributions are always welcome. please email patches to ubq323 at ubq323 dot website.
+
+## license
+AGPLv3, see LICENSE.
+
+Copyright (C) 2021-2022 apioforum contributors.