abouttreesummaryrefslogcommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorpatrick-scho2025-04-23 12:32:45 +0200
committerpatrick-scho2025-04-23 12:32:45 +0200
commit975845bfb7532dd679a4668e1ad1fda9424cd30d (patch)
tree828277ba868aa77351ddd4e49d1d500e8a4154eb /readme.md
parent5fef0d4ca47771f4134d3d5f9d218a3ec73b81bb (diff)
downloadchirp-975845bfb7532dd679a4668e1ad1fda9424cd30d.tar.gz
chirp-975845bfb7532dd679a4668e1ad1fda9424cd30d.zip
update readmeHEADmain
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index dc2dd94..b374c01 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,13 @@
# 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