## 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)
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"