diff --git a/README.md b/README.md index c093b18..5d12f51 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,18 @@ Custom [`libp2p`](https://libp2p.io/)-based Go binaries for testing p2p connectivity in the following scenarios: -* Public ipv4 to public ipv4 -* Public to private (behind NAT) and viceversa -* Private to private (behind NAT, using holepunching) -* Using the [Tor transport](https://github.com/berty/go-libp2p-tor-transport) +* Public IPv4 to public IPv4. +* Public to private (behind NAT) and viceversa. +* Private to private (behind NAT, using holepunching). +* Use of the [Tor transport](https://github.com/berty/go-libp2p-tor-transport). +* Use of public IPFS relay & DHT. ## Assumptions I am exploring the possibility of creating network conditions which resemble -those of the [scuttleverse](https://www.scuttlebutt.nz/). Peers are offline -friends and have some out-of-band method of connecting to each other first. So, -for example, I don't want to make use of a public DHT by default. +those of the [Scuttleverse](https://www.scuttlebutt.nz/). Peers are already +offline friends and have some out-of-band method for sharing connection details +(e.g. a [Cabal](https://cabal.club) chat). To facilitate holepunching and avoid public IPFS relays or DHT, I want to use a private self-hosted relay. No standard bootstrapping nodes should be required, @@ -23,18 +24,18 @@ everything is "in house" (like a "pub" or "room" in SSB). I make explicit use of [Noise](https://docs.libp2p.io/concepts/secure-comm/noise/) for encryption -because I control the peer implementation on both sides (guaranteed to be +because we control the peer implementation on both sides (guaranteed to be available). Sometimes, it might be handy to make use of public IPFS relays or DHT, so I will leave this as an optional approach. The important point is that this will not be the default. -Local-first connections should also work. +Local-first connections should also work reliably. Since `libp2p` was built within the context of a global connectivity mindset, I -am exploring whether the feature set works for peer connectivity between a -small group of friends. +am exploring how local-first and "private" connectivity works between a small +group of friends. ## Goals