Matrix notification

README.md

@@ -0,0 +1,38 @@
+# webcomment
+
+Rust webserver for comments, that you can easily embed in a website.
+
+**Early development, not safe for production yet**
+
+## Features
+
+* List and post comments by topic (e.g. each article in your blog is a topic)
+* Admin approval
+* Admin notification on new comment via Matrix
+* Embedded one-file webserver
+* [Tera](https://github.com/Keats/tera) templates
+
+## Use
+
+    webcomment init
+    
+    # This adds an admin password to the config (password are hashed)
+    webcomment psw
+    
+    # edit ~/.config/webcomment/config.toml
+    
+    webcomment start
+
+Each topic is accessible at `/t/<topic_name>`.
+
+Admin login is accessible at `/admin`. Once authenticated, you can see the pending comments on the topic pages.
+
+## License
+
+CopyLeft 2022 Pascal Engélibert [(why copyleft?)](//txmn.tk/blog/why-copyleft/)
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.