aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorMax Audron <audron@cocaine.farm>2024-05-22 13:15:38 +0200
committerMax Audron <audron@cocaine.farm>2024-05-22 13:15:38 +0200
commit95845f8a372472907b8c5b36f00305ec3442ce38 (patch)
tree6537244df236af126907c5caf9625c4929d63b44 /README.org
parentsplit channel modes into their own struct (diff)
add todos to readme
Diffstat (limited to '')
-rw-r--r--README.org35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..452c579
--- /dev/null
+++ b/README.org
@@ -0,0 +1,35 @@
+#+TITLE: libquassel
+Native rust implementation of the Quassel protocol and library functions
+
+* Features
+| Feature | Description |
+|----------------------+------------------------------------------------------|
+| client | Enable client side trait implementations |
+| server | Enable server side trait implementations |
+| framing | Enable support for tokio's [[url:https://docs.rs/tokio-util/latest/tokio_util/codec/struct.Framed.html][codec::Framed]] |
+| all-quassel-features | enable all protocol features |
+| long-message-id | Serialize message IDs as i64 |
+| long-time | Serialize Message Time as i64 |
+| rich-messages | add avatar url and real name to messages |
+| sender-prefixes | Show prefixes for senders in backlog |
+| authenticators | Support for exchangeable auth backends |
+| bench | Enable the test crate/feature for running benchmarks |
+
+* TODOs
+** TODO Implementation of Syncable Objects
+*** DONE AliasManager
+*** TODO BacklogManager
+*** DONE BufferSyncer
+*** DONE BufferViewConfig
+*** DONE BufferViewManager
+*** DONE CertManager
+*** DONE CoreInfo
+*** DONE HighlightRuleManager
+*** DONE Identity
+*** DONE IgnoreListManager
+*** DONE IrcChannel
+*** TODO IrcListHelper
+*** TODO IrcUser
+*** TODO Network
+*** TODO NetworkInfo
+*** TODO NetworkConfig