Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amirongit committed Aug 2, 2024
2 parents 89153a3 + 634c8f9 commit 44c5373
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ a desperate attempt to rebel
a decentralized messenger designed to bypass blockages which intentionally avoids having a single point of failure or downtime caused by censorship

## how does
four key concepts
four key concepts (network is the fourth, nerds)
- messages: encrypted or raw data in text or string format (the only supported data type) sent from a source peer to a target peer
- peers: users with two pairs of asymmetrical keys (one for authentication & one for encryption) registered in a node
- nodes: instances of the software that manage messages & peers; nodes can connect to each other to form a network, authenticate peers (directly or indirectly), exchange data about themselves & their peers & act on behalf of other peers if necessary
Expand All @@ -16,3 +16,5 @@ the swagger client can be used for now; don't have a plan (& urge) to right a us
## when
these should be done in order to have an rc release (could be updated)
- integration tests
these should be done in order to have an actual release (could be updated)
- have a security expert review the code & flows

0 comments on commit 44c5373

Please sign in to comment.