Add readme

Author: NaikSoftware

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nickolay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,110 @@
+# STOMP protocol via WebSocket for Android
+
+[![Release](https://jitpack.io/v/NaikSoftware/StompProtocolAndroid.svg)](https://jitpack.io/#NaikSoftware/StompProtocolAndroid)
+
+## Overview
+
+This library provide support for STOMP protocol https://stomp.github.io/
+At now library works only as client for backend with support STOMP, such as
+NodeJS (stompjs or other) or Spring Boot (SockJS).
+
+Add library as gradle dependency
+
+```gradle
+repositories { 
+    jcenter()
+    maven { url "https://jitpack.io" }
+}
+dependencies {
+    compile 'com.github.NaikSoftware:StompProtocolAndroid:{latest version}'
+}
+```
+
+## Example backend (Spring Boot)
+
+**WebSocketConfig.groovy**
+```groovy
+@Configuration
+@EnableWebSocketMessageBroker
+public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {
+
+    @Override
+    public void configureMessageBroker(MessageBrokerRegistry config) {
+        config.enableSimpleBroker("/topic");
+        config.setApplicationDestinationPrefixes("/app");
+    }
+
+    @Override
+    public void registerStompEndpoints(StompEndpointRegistry registry) {
+        registry.addEndpoint("/hello")/*.setAllowedOrigins('*')*/.withSockJS();
+    }
+
+}
+```
+
+**HelloSockController.groovy**
+``` groovy
+@RestController
+class HelloSockController {
+
+    @MessageMapping("/hello")
+    @SendTo("/topic/greetings")
+    def greeting(String msg) throws Exception {
+        println("Receive greeting ${msg}")
+        "ECHO: " + msg;
+    }
+}
+```
+
+## Example library usage
+
+**Basic usage**
+``` java
+ private StompClient mStompClient;
+ 
+ // ...
+ 
+ mStompClient = Stomp.over(WebSocket.class, "ws://localhost:8080/app/hello/websocket");
+ mStompClient.connect();
+  
+ mStompClient.topic("/topic/greetings").subscribe(topicMessage -> {
+     Log.d(TAG, topicMessage.getPayload());
+ });
+  
+ mStompClient.send("/app/hello", "My first STOMP message!").subscribe();
+  
+ // ...
+ 
+ mStompClient.disconnect();
+
+```
+
+Method `Stomp.over` consume class for create connection as first parameter.
+You must provide dependency for lib and pass class.
+At now supported connection providers:
+- WebSocket.class ('org.java-websocket:Java-WebSocket:1.3.0')
+
+You can add own connection provider. Just implement interface `ConnectionProvider`.
+If you implement new provider, please create pull request :)
+
+**Subscribe lifecycle connection**
+``` java
+mStompClient.lifecycle().subscribe(lifecycleEvent -> {
+    switch (lifecycleEvent.getType()) {
+    
+        case OPENED:
+            Log.d(TAG, "Stomp connection opened");
+            break;
+            
+        case ERROR:
+            Log.e(TAG, "Error", lifecycleEvent.getException());
+            break;
+            
+        case CLOSED:
+             Log.d(TAG, "Stomp connection closed");
+             break;
+    }
+});
+```
+
+Library support just send & receive messages. ACK messages, transactions not implemented yet.