From 9c9188c70533ae5da9f7f2b6f63c78e2d5200636 Mon Sep 17 00:00:00 2001
From: Himadri Bhattacharjee <107522312+lavafroth@users.noreply.github.com>
Date: Wed, 19 Mar 2025 12:48:42 +0530
Subject: [PATCH] feat: add readme

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85065de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# publik
+
+Private chats using public keys.
+
+Publik aims to be an subset of IRC, replacing the "default permit" policy with invite only.
+New users can be added by modifying the authorization file `authfile` either via the chat
+interface or by editing it externally.
+
+The `authfile` is the source of truth. Over multiple runs or reloads of the server, the state
+of who is authorized is reflected in the `authfile`.
+
+Ephemeral keys can be added via the chat interface but unless the changes are committed using the `/commit`
+command, the changes will NOT persist on the next run or when an admin performs a reload.