]> gitweb.ps.run Git - chirp/commitdiff
update readme main
authorpatrick-scho <patrick.schoenberger@posteo.de>
Wed, 23 Apr 2025 10:32:45 +0000 (12:32 +0200)
committerpatrick-scho <patrick.schoenberger@posteo.de>
Wed, 23 Apr 2025 10:32:45 +0000 (12:32 +0200)
readme.md

index dc2dd942ed3652bd87dfc2d8b4bf3983ca0953e1..b374c016e3f6b23cfb824aeed0838077a407bdd7 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,13 @@
 # Chirp
 
 # Chirp
 
-This is a stub.
+Chirp is a proof of concept for a simple micro-blogging platform, developed with no prior knowledge and no research into this topic to explore the problem space intuitively.
+This is the third iteration, which is written in the [Zig programming language](https://ziglang.org), using a [custom HTTP handler based on epoll](https://git.psch.dev/zighttp) and a [custom abstraction over the LMDB key-value-store](https://git.psch.dev/ziglmdb), making [LMDB](https://www.symas.com/mdb) the only external dependency.
+It works without JavaScript by generating all HTML dynamically and with no dynamic allocations on the server.
+
+Features:
+- Registration and login of users
+- Creating posts
+- Up/downvoting
+- Comments, quote-posts
+- Following users and dynamically generated timelines
+- Creating and managing lists of posts and custom feeds