From 3db510ec5fc1d7ea9e7c6952f7a8269ddfbbf146 Mon Sep 17 00:00:00 2001
From: Cadence Ember <cadence@disroot.org>
Date: Tue, 20 Oct 2020 02:52:10 +1300
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..75b3ef3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# Carbon Chat
+
+Carbon is the Matrix client for Discord refugees.
+
+## The dream
+
+Carbon's planned features, compared to Discord:
+
+- End to end encryption
+- $0 per-account custom emojis and custom emoji packs
+- Uses the open Matrix and Mumble systems
+- Much better IRC layout
+- Probably more
+
+Carbon's planned features, compared to Element:
+
+- Get rid of the unmanageable combined rooms list
+- Groups like Discord's guilds
+  - Always have one group selected at a time
+  - Synchronised membership, moderators, power levels and bans
+  - Ordered channel list
+  - Unread indicators
+- Add existing channels to groups
+- Pin any channel to the groups bar
+- Tidy Mumble integration to add voice channels
+- More reliable unreads
+- Per-account custom emojis (Ponies+FluffyChat integration) and custom emoji packs
+- Slightly better IRC layout
+- Probably more
+
+## The reality
+
+Carbon is currently _technically_ usable as a chat app, but is very
+early in development. These important features still need to be
+implemented:
+
+- Login GUI
+- Unreads
+- Chat history
+- Formatting
+- Emojis
+- Reactions
+- Groups v2
+- Group management
+- Pinned channels
+- Mumble integration
+
+## The code
+
+### Building
+
+    npm install -D
+    npm run rebuild
+
+### Hosting
+
+Send the files from the `build` folder to a static file server. Apply
+a long cache-control header to everything served under `/static`, and
+no cache-control header to everything else.
+
+### Developing
+
+    npm run watch
+
+Files will be rebuilt as you save them.