Version 0.1.1

Author: Daniel Rees

README.md

@@ -1,10 +1,10 @@
 # JavaPhoenixClient
 
 
-## Java Client for Phoenix Channels
+JavaPhoenixClient is a Kotlin implementation of the [phoenix.js](https://hexdocs.pm/phoenix/js/) client used to manage Phoenix channels.
 
-JavaPhoenixClient is a Kotlin implementation of the `[phoenix.js] client used to manage Phoenix channels.
 
+### Basic Usage
 
 ```kotlin
 
@@ -16,9 +16,9 @@ fun connectToChatRoom() {
 
     // Listen to events on the Socket
     socket.logger = { Log.d("TAG", it) }
-    socket.onOpen { Timber.d("Socket Opened") }
-    socket.onClose { Timber.d("Socket Closed") }
-    socket.onError { Timber.d(it, "Socket Error") }
+    socket.onOpen { Log.d("TAG", "Socket Opened") }
+    socket.onClose { Log.d("TAG", "Socket Closed") }
+    socket.onError { Log.d(it, "TAG", "Socket Error") }
 
     socket.connect()
 
@@ -34,3 +34,32 @@ fun connectToChatRoom() {
             .receive("error") { /* failed to join the chatroom */ }
 }
 ```
+
+
+### Installation
+
+JavaPhoenixClient is hosted on JCenter. You'll need to make sure you declare `jcenter()` as one of your repositories
+ 
+```
+repositories {
+    jcenter()
+}
+```
+
+and then add the library. See [releases](https://github.com/dsrees/JavaPhoenixClient/releases) for the latest version
+```$xslt
+dependencies {
+    implementation 'com.github.dsrees:JavaPhoenixClient:0.1.1'
+}
+```
+
+
+### Feedback
+Please submit in issue if you have any problems!
+
+
+
+This library is built to mirror the [phoenix.js](https://hexdocs.pm/phoenix/js/) and [SwiftPhoenixClient](https://github.com/davidstump/SwiftPhoenixClient) libraries.
+
+
+

build.gradle

@@ -8,7 +8,7 @@ plugins {
 }
 
 group 'com.github.dsrees'
-version '0.1.0'
+version '0.1.1'
 
 sourceCompatibility = 1.8