Change package name and add a package comment

client/lib/interfaces.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 // Tongue is an interface for catching Snowflakes. (aka the remote dialer)
 type Tongue interface {

client/lib/lib_test.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 import (
 	"fmt"

client/lib/peers.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 import (
 	"container/list"

client/lib/rendezvous.go

@@ -1,7 +1,7 @@
 // WebRTC rendezvous requires the exchange of SessionDescriptions between
 // peers in order to establish a PeerConnection.
 
-package lib
+package snowflake_client
 
 import (
 	"errors"

client/lib/rendezvous_ampcache.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 import (
 	"errors"

client/lib/rendezvous_http.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 import (
 	"bytes"

client/lib/rendezvous_test.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 import (
 	"bytes"

client/lib/snowflake.go

@@ -1,4 +1,31 @@
-package lib
+/*
+Package snowflake_client implements functionality necessary for a client to establish a connection
+to a server using Snowflake.
+
+Included in the package is a Transport type that implements the Pluggable Transports v2.1 Go API
+specification. To use Snowflake, you must first create a client from a configuration:
+
+	config := snowflake_client.ClientConfig{
+		BrokerURL:   "https://snowflake-broker.example.com",
+		FrontDomain: "https://friendlyfrontdomain.net",
+		Max: 1,
+		// ...
+	}
+	transport, err := snowflake_client.NewSnowflakeClient(config)
+	if err != nil {
+		// handle error
+	}
+
+The Dial function connects to a Snowflake server:
+
+	conn, err := transport.Dial()
+	if err != nil {
+		// handle error
+	}
+	defer conn.Close()
+
+*/
+package snowflake_client
 
 import (
 	"context"

client/lib/turbotunnel.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 import (
 	"bufio"

client/lib/util.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 import (
 	"log"

client/lib/webrtc.go

@@ -1,4 +1,4 @@
-package lib
+package snowflake_client
 
 import (
 	"crypto/rand"