documented onionrusers better with readme

This commit is contained in:
Kevin Froman 2019-06-13 14:53:20 -05:00
parent 5edf0e234a
commit c85bb73d77
2 changed files with 9 additions and 0 deletions

View File

@ -0,0 +1,9 @@
# onionrusers
onionrusers is a small collection of classes for interacting with onionr public keys, such as encrypting messages to them with forward secrecy, interacting with their settings, or else.
## Files
onionrusers.py: OnionrUsers class can be used to encrypt/decrypt messages to a particular Onionr user (incl. forward secrecy), view information about them, and get our friend list.
contactmanager.py: Inheriting from OnionrUsers, ContactManager allows arbitrary information to be associated with an Onionr user.

View File