added more subdirectory readmes

This commit is contained in:
Kevin Froman 2019-06-13 11:24:34 -05:00
parent 64944f6f7c
commit 5edf0e234a
5 changed files with 22 additions and 3 deletions

View File

@ -1,5 +1,11 @@
# etc # 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 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 onionrvalues.py: spec values for onionr blocks and other things

View File

@ -1,6 +1,6 @@
# httpapi # 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: ## Files:

View File

@ -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.

View File

@ -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 Sets more abstract information related to a peer. Can be thought of as traditional 'contact' system
''' '''

View File

@ -1,5 +1,5 @@
''' '''
Onionr - P2P Anonymous Storage Network Onionr - Private P2P Communication
Contains abstractions for interacting with users of Onionr Contains abstractions for interacting with users of Onionr
''' '''