aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Audron <audron@cocaine.farm>2021-11-29 14:26:36 +0100
committerMax Audron <audron@cocaine.farm>2021-11-29 14:27:09 +0100
commiteb9b8dbd46223f4dad01b1a90be3cd46ab2370ac (patch)
tree398d28cc58207f14b0c66fbe1a3316d3805aa063
parentadd HighlightRuleManager sync implementations (diff)
add feature list to readme
-rw-r--r--.gitignore1
-rw-r--r--README.md13
2 files changed, 14 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 707473a..90e6d98 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,4 @@ Cargo.lock
**/*.rs.bk
examples/testserver
lcov.info
+README.org
diff --git a/README.md b/README.md
index cd5065f..c34cb1b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
# 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 [codec::Framed](https://docs.rs/tokio-util/latest/tokio_util/codec/struct.Framed.html) |
+| 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 |