From: Christopher Coté <chris@entropealabs.com>
Date: Thu, 20 Jul 2023 15:32:14 +0000 (-0400)
Subject: update README
X-Git-Url: http://git.entropealabs.com/?a=commitdiff_plain;h=d26d973fccc0a9b2cdaf0d77a4af3347047c21e9;p=wampex_client.git

update README
---

diff --git a/README.md b/README.md
index a650d58..697c04c 100644
--- a/README.md
+++ b/README.md
@@ -80,24 +80,23 @@ MessagePack and JSON serialization are both supported
 
 ## Installation
 
-Currently it's not available on hex.pm. I want to get a little more real-world testing done before committing to the implementation. However, it is available on Gitlab. You can add the following to your `mix.exs` file to use it.
+You can find the package on hex.pm here, https://hex.pm/packages/wampex_client
+
 
 ```elixir
 def deps do
   [
-    {:wampex_client,
-       git: "https://gitlab.com/entropealabs/wampex_client",
-       tag: "5c8b95114bfc11b8c9ce92803f22c088b34a78eb"}
+    {:wampex_client, "~> 0.1.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`.
-
 Module documentation is light at the moment, but everything has specs and passes Dialyzer testing.
 
+https://hexdocs.pm/wampex_client/readme.html
+
 ## Usage
 
 You can see a full example app, emulating a Smart Home and backend system [here](https://gitlab.com/entropealabs/wampex_example_app)
@@ -131,7 +130,7 @@ You can override the default serializer and transport like this.
 alias Wampex.Client.Session
 alias Wampex.Client.Realm
 alias Wampex.Role.{Callee, Caller, Publisher, Subscriber}
-alias Wampex.Serializer.JSON
+alias Wampex.Serializers.JSON
 alias Wampex.Client.Transport.WebSocket
 
 url = "http://localhost:18080/ws"