From c62acb276328798fe06c7fcd142918140982c1e0 Mon Sep 17 00:00:00 2001
From: Jeromy <jeromyj@gmail.com>
Date: Sat, 8 Nov 2014 20:45:12 -0800
Subject: [PATCH] copy handshake readme into a doc.go for pretty godoc results

---
 net/handshake/doc.go | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 net/handshake/doc.go

diff --git a/net/handshake/doc.go b/net/handshake/doc.go
new file mode 100644
index 000000000..3c4bff006
--- /dev/null
+++ b/net/handshake/doc.go
@@ -0,0 +1,34 @@
+/*
+package handshake implements the ipfs handshake protocol
+
+IPFS Handshake
+
+The IPFS Protocol Handshake is divided into three sequential steps
+
+1. Version Handshake (`Hanshake1`)
+
+2. Secure Channel (`NewSecureConn`)
+
+3. Services (`Handshake3`)
+
+Currently these parts currently happen sequentially (costing an awful 5 RTT),
+but can be optimized to 2 RTT.
+
+Version Handshake
+
+The Version Handshake ensures that nodes speaking to each other can interoperate.
+They send each other protocol versions and ensure there is a match on the major
+version (semver).
+
+Secure Channel
+
+The second part exchanges keys and establishes a secure comm channel. This
+follows ECDHE TLS, but *isn't* TLS. (why will be written up elsewhere).
+
+Services
+
+The Services portion sends any additional information on nodes needed
+by the nodes, e.g. Listen Address (the received address could be a Dial addr),
+and later on can include Service listing (dht, exchange, ipns, etc).
+*/
+package handshake
-- 
GitLab