diff options
| author | Max Audron <audron@cocaine.farm> | 2025-02-22 18:39:52 +0100 |
|---|---|---|
| committer | Max Audron <audron@cocaine.farm> | 2025-02-22 18:39:52 +0100 |
| commit | 9411cfa7572431801872152d8d964634e1504b89 (patch) | |
| tree | 124aa797ae433ab8db0d282661eb4a8f63a7b0c8 /README.md | |
| parent | add todos to readme (diff) | |
update flake
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..60de75d --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +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](url: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 | +| bench | Enable the test crate/feature for running benchmarks | + +# TODOs + +- [TODO] Implementation of Syncable Objects {#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 |