about summary refs log tree commit diff
path: root/web/converse/README.md
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2021-04-05T15·20+0200
committertazjin <mail@tazj.in>2021-04-05T15·47+0000
commit5387cc9e7d7ef5ca9ecaeea46132510298902769 (patch)
treee32c1bfd1eafd306076405df3cb141b0c1cb7316 /web/converse/README.md
parent8e91e70b053e29a1ff56a44ef101c71301bcd7ea (diff)
docs(converse): Convert README to Markdown r/2442
Change-Id: Iad5902622a9993c94116edc55de8fa5f6c38d3f1
Reviewed-on: https://cl.tvl.fyi/c/depot/+/2856
Tested-by: BuildkiteCI
Reviewed-by: sterni <sternenseemann@systemli.org>
Diffstat (limited to 'web/converse/README.md')
-rw-r--r--web/converse/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/web/converse/README.md b/web/converse/README.md
new file mode 100644
index 000000000000..e7a3f70aec07
--- /dev/null
+++ b/web/converse/README.md
@@ -0,0 +1,14 @@
+Converse
+========
+
+Welcome to Converse, a work-in-progress forum software written in
+Rust. The intention behind Converse is to provide a simple forum-like
+experience.
+
+There is not a lot of documentation about Converse yet and it has
+several known issues. Also note that Converse is being developed for a
+specific use-case and is not going to be a forum feature kitchen-sink
+like most classical forum softwares.
+
+Better documentation is forthcoming once the remaining basics have
+been taken care of.