Shiloh/remnantchat
Shiloh/remnantchat
1
0
Fork 1
Code Issues Pull Requests Packages Projects 4 Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
Jeremy Kahn 2022-11-07 08:46:43 -06:00
parent 51a17a72a3
commit 29aef6514b
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -28,6 +28,7 @@ Open https://chitchatter.im/ and join a room to start chatting with anyone else
- Multiple peers per room (limited only by the number of peer connections your browser supports). - Multiple peers per room (limited only by the number of peer connections your browser supports).
- Public and private rooms - Public and private rooms
- Video and audio chatting
- Markdown support via [`react-markdown`](https://github.com/remarkjs/react-markdown). - Markdown support via [`react-markdown`](https://github.com/remarkjs/react-markdown).
- Includes support for syntax highlighting of code. - Includes support for syntax highlighting of code.
- Conversation backfilling from peers when a new participant joins - Conversation backfilling from peers when a new participant joins
@ -37,9 +38,9 @@ Open https://chitchatter.im/ and join a room to start chatting with anyone else
## Anti-features ## Anti-features
- Messages are never persisted to disk. When you leave a peer room, messages are cleared from memory and cannot be retrieved. - Messages are never persisted to disk. When you leave a peer room, messages are cleared from memory and cannot be retrieved.
- Chitchatter is an entirely client-side communication app. It uses external general-purpose WebTorrent and STUN/TURN servers as for necessary communication, but there is no Chitchatter API server. - Chitchatter is an entirely client-side communication app. It uses public WebTorrent servers to establish peer connections and STUN/TURN relay servers when direct peer-to-peer connections cannot be established, but there is no Chitchatter API server.
- No analytics, tracking, or telemetry. - No analytics, tracking, or telemetry.
- This is a community-driven, unfunded project that makes no money. This is necessary to prevent corporate influence from harming users. - This is a community-driven and unfunded project that makes no money. The users come first and there are no corporate or financial interests.
## Why another chat app? ## Why another chat app?
@ -89,12 +90,9 @@ Chitchatter is an open source project, so community contributions and support ar
This is a non-exhaustive list of things that are in Chitchatter's future: This is a non-exhaustive list of things that are in Chitchatter's future:
- Password-protected rooms - Screen sharing
- Voice calling
- Video calling
- File sharing - File sharing
- Indicators for when others are typing - Indicators for when others are typing
- Transcript backfilling for peers who join a room after there has already been activity
See the full ticket backlog [here](https://github.com/users/jeremyckahn/projects/1). See the full ticket backlog [here](https://github.com/users/jeremyckahn/projects/1).