From 5edf0e234abf839d9dd8a14222e9ac4d3b0c5833 Mon Sep 17 00:00:00 2001 From: Kevin Froman Date: Thu, 13 Jun 2019 11:24:34 -0500 Subject: [PATCH] added more subdirectory readmes --- onionr/etc/README.md | 6 ++++++ onionr/httpapi/README.md | 2 +- onionr/onionrservices/README.md | 13 +++++++++++++ onionr/onionrusers/contactmanager.py | 2 +- onionr/onionrusers/onionrusers.py | 2 +- 5 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 onionr/onionrservices/README.md diff --git a/onionr/etc/README.md b/onionr/etc/README.md index c5c054ea..9b310d28 100644 --- a/onionr/etc/README.md +++ b/onionr/etc/README.md @@ -1,5 +1,11 @@ # etc +Files that don't really fit anywhere else, but aren't used very frequently. + +## Files + +humanreadabletime.py: take integer seconds and return a human readable time string + pgpwords.py: represent data using the pgp word list: https://en.wikipedia.org/wiki/PGP_word_list onionrvalues.py: spec values for onionr blocks and other things \ No newline at end of file diff --git a/onionr/httpapi/README.md b/onionr/httpapi/README.md index b048b2c3..a4cf7eeb 100644 --- a/onionr/httpapi/README.md +++ b/onionr/httpapi/README.md @@ -1,6 +1,6 @@ # httpapi -The httpapi contains collections of endpoints for the client API server. +The httpapi contains collections of endpoints for the client and public API servers. ## Files: diff --git a/onionr/onionrservices/README.md b/onionr/onionrservices/README.md new file mode 100644 index 00000000..2022231c --- /dev/null +++ b/onionr/onionrservices/README.md @@ -0,0 +1,13 @@ +# onionrservices + +onionservices is a submodule to handle direct connections to Onionr peers, using the Onionr network to broker them. + +## Files + +__init__.py: Contains the OnionrServices class which can create direct connection servers or clients. + +bootstrapservice.py: Creates a bootstrap server for a peer and announces the connection by creating a block encrypted to the peer we want to connect to. + +connectionserver.py: Creates a direct connection server for a peer + +httpheaders.py: Modifies a Flask response object http response headers for security purposes. \ No newline at end of file diff --git a/onionr/onionrusers/contactmanager.py b/onionr/onionrusers/contactmanager.py index c47bbe45..0524ed64 100755 --- a/onionr/onionrusers/contactmanager.py +++ b/onionr/onionrusers/contactmanager.py @@ -1,5 +1,5 @@ ''' - Onionr - P2P Anonymous Storage Network + Onionr - Private P2P Communication Sets more abstract information related to a peer. Can be thought of as traditional 'contact' system ''' diff --git a/onionr/onionrusers/onionrusers.py b/onionr/onionrusers/onionrusers.py index e05aac0e..9e26d047 100755 --- a/onionr/onionrusers/onionrusers.py +++ b/onionr/onionrusers/onionrusers.py @@ -1,5 +1,5 @@ ''' - Onionr - P2P Anonymous Storage Network + Onionr - Private P2P Communication Contains abstractions for interacting with users of Onionr '''