Create README.md

This commit is contained in:
AtHeartEngineer
2023-07-09 19:26:55 -04:00
committed by GitHub
commit 3c2bdb851a

25
README.md Normal file
View File

@@ -0,0 +1,25 @@
# Discreetly
## About Discreetly
Discreetly is an anonymous and federated chat application.
Under the hood it uses a zero-knowledge protocol called RLN (Rate-Limiting Nullifier) to rate limit messages per user.
Read more about [RLN](https://rate-limiting-nullifier.github.io/rln-docs/).
## Features
* Truly anonymous
* It uses RLN to prove you are a member of a room, but not who you are.
* If you don't trust the server, run your own
* Federated
* Run your own server, and use the same frontend as everyone else, or run your own frontend too.
* Spammers are banned
* If someone tries to send messages faster than the rate limit allowed, they are automatically banned, and there is no unban.
## Stack
### [Frontend](github.com/Discreetly/frontend)
* Svelte
* Socketio
### [Server](github.com/Discreetly/server)
* Express
* Socketio