commit 7ebe446ab690ea12900a91403441a0932e1e1c43 parent 439ac37956e6fdd745aa9de01011b4775628eeae Author: parazyd <parazyd@dyne.org> Date: Sun, 21 Mar 2021 12:31:11 +0100 Add some notes in the Readme. Diffstat:
| M | README.md | | | 23 | ++++++++++++++++++----- |
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md @@ -21,10 +21,23 @@ Documentation https://pkg.go.dev/github.com/parazyd/tordam -tor-dam is a small library that can be used to facilitate peer to peer -services in the Tor network with simple mechanisms. +tor-dam is a small library that can be used to facilitate peer to +peer services in the Tor network with simple mechanisms. -A basic integration example can be found and reviewed in the form of -a single go file: [cmd/tor-dam/tor-dam.go](cmd/tor-dam/tor-dam.go). +An integration example can be found and reviewed in the form of a +single go file: [cmd/tor-dam/tor-dam.go](cmd/tor-dam/tor-dam.go). It +is procedural and well-documented so it should serve well for learning +how to integrate the library into a Go program. -Most of the library's code is documented in the source, along with godoc. +Most of the library's code is documented in the source, along with +godoc. + + +Feature list +------------ + +* Anonymous peer mapping in the Tor network +* Launching Tor and Hidden Services +* Port mapping to launched hidden service for easy anonymous services +* Exporting available peers through any marshaling interface (think + peer list as JSON)