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
1 parent 228914b commit 2c91c5e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,10 @@ four key concepts
- 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

## how to
the swagger client can be used for now; don't have a plan (& urge) to right a user interface

## when
these should be done in order to have an rc release (could be updated)
- integration tests

0 comments on commit 2c91c5e

Please sign in to comment.