From c85bb73d776cc1f1ef935e0683e0f27121c66f66 Mon Sep 17 00:00:00 2001 From: Kevin Froman Date: Thu, 13 Jun 2019 14:53:20 -0500 Subject: [PATCH] documented onionrusers better with readme --- onionr/onionrusers/README.md | 9 +++++++++ onionr/onionrusers/__init__.py | 0 2 files changed, 9 insertions(+) create mode 100644 onionr/onionrusers/README.md create mode 100644 onionr/onionrusers/__init__.py diff --git a/onionr/onionrusers/README.md b/onionr/onionrusers/README.md new file mode 100644 index 00000000..e85c0952 --- /dev/null +++ b/onionr/onionrusers/README.md @@ -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. \ No newline at end of file diff --git a/onionr/onionrusers/__init__.py b/onionr/onionrusers/__init__.py new file mode 100644 index 00000000..e69de29b