Skip to content

Commit 53da258

Browse files
authored
Update Readme.md
1 parent 5accb5a commit 53da258

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

Readme.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,38 @@
1-
# Accord
2-
Instant messaging program (server and bare-bones tui client).
1+
<img src="https://user-images.githubusercontent.com/46327403/165834531-901c95d3-a932-4059-90f9-b1bcfa7178ad.svg" height="100">
2+
3+
---
4+
5+
6+
**Instant messaging chat system over TCP.**
37
Written in Rust with tokio-rs.
4-
Packet design inspired partially by Minecraft.
8+
Packet design and handshake inspired partially by Minecraft.
9+
10+
<img src="https://user-images.githubusercontent.com/46327403/165838116-f0b38ddf-f1f8-4c59-9474-580397daf443.png" width="100%">
11+
12+
13+
## Features
14+
- Standalone server
15+
- GUI client (using `druid` UI toolkit) with customizations via config file
16+
- TUI client
17+
- Encryption
18+
- Sending images (via clipboard)
19+
- Server management (banning, whitelists, etc)
20+
21+
## Short-term goals
22+
- Improve GUI experience (sidebar with active users, loading up past messages and more)
23+
- Verify that the encryption is secure
24+
- Add more features
25+
26+
## Long-term goals
27+
- Figure out long-term goals
28+
29+
## The Stack
30+
- Server:
31+
- tokio-rs
32+
- postgres
33+
- GUI:
34+
- tokio-rs
35+
- druid
536

637
## Setting up accord server
738
1. Obtain `accord-server` binary.
@@ -14,7 +45,8 @@ cargo b -p accord-server --release
1445
2. Set up postgresql database somewhere.
1546
Refer to postgres instructions for how to do that.
1647
4. Launch `accord-server`. It will error something about connecting to the database, but we just need the default config.
17-
5. Edit the config (probably located in `.config/accord-server/config.toml`) with correct postgres credentials.
48+
5. Edit the config (probably located in `~/.config/accord-server/config.toml`) with correct postgres credentials.
1849
6. Launch `accord-server` again, this time it should connect.
1950
7. Done!
2051
Now clients can connect.
52+

0 commit comments

Comments
 (0)