From: Christopher <chris@entropealabs.com>
Date: Tue, 18 Feb 2020 15:19:40 +0000 (-0600)
Subject: note about documentation
X-Git-Url: http://git.entropealabs.com/?a=commitdiff_plain;h=9cec56b8e8e01bb0d29bd985d38c03eb4d6336fa;p=wampex.git

note about documentation
---

diff --git a/README.md b/README.md
index 3d1ab1f..888ffe0 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,9 @@ end
 
 ## Documentation
 
-The package isn't published to hex yet, so to view the docs you'll need to check out the repo and run `mix docs`.
+The package isn't published to hex yet, so to view the docs you'll need to check out the repo and run `mix docs`. 
+
+Module documentation is light at the moment, but everything has specs and passes Dialyzer testing.
 
 ## Usage
 
@@ -70,7 +72,7 @@ Wampex.start_link(name: Connection, session: session)
 
 The protocol uses a registered [WebSocket subprotocol](https://wamp-proto.org/_static/gen/wamp_latest.html#websocket-transport), there are several values available. You need to ensure that the [Router](https://wamp-proto.org/_static/gen/wamp_latest.html#peers-and-roles) that you connect to also supports the subprotocol.
 
-### ImplementationDetails
+### Implementation Details
 
 WAMPex currently maps each session to a seperate transport connection. This means there is a new conection per instance of WAMPex.