Add README.md and update some file's comment etc

shiyinghan · shiyinghan · commit 2b630d529262 · 2021-04-07T15:04:29.000+08:00
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# Mqtt Android Service
+
+[![](https://jitpack.io/v/shiyinghan/MqttAndroid.svg)](https://jitpack.io/#shiyinghan/MqttAndroid)
+
+The Mqtt Android Service is an MQTT client library for developing applications on Android,based on Eclipse Paho Java MQTT Client.
+
+## Using the Mqtt Android Client
+
+**Step 1.** Add it in your root **build.gradle** at the end of repositories:
+
+```groovy
+	allprojects {
+		repositories {
+			...
+			maven { url 'https://jitpack.io' }
+		}
+	}
+```
+
+**Step 2.** Add the dependency:
+
+```groovy
+dependencies {
+	        implementation 'com.github.shiyinghan:MqttAndroid:1.0.0'
+	}
+```
+
diff --git a/app/build.gradle b/app/build.gradle
@@ -71,4 +71,5 @@ dependencies {
     androidTestImplementation deps.espresso
 
     implementation project(path: ':mqtt')
+//    implementation 'com.github.shiyinghan:MqttAndroid:1.0.0'
 }
diff --git a/app/src/main/java/com/shiyinghan/mqttdemo/utils/NotifyUtil.java b/app/src/main/java/com/shiyinghan/mqttdemo/utils/NotifyUtil.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 1999, 2014 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqttdemo.utils;
 
 import android.app.Notification;
diff --git a/mqtt/src/androidTest/java/com/shiyinghan/mqtt/android/AndroidServiceWithActionListenerTest.java b/mqtt/src/androidTest/java/com/shiyinghan/mqtt/android/AndroidServiceWithActionListenerTest.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 2014 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android;
 
 import java.util.concurrent.TimeUnit;
diff --git a/mqtt/src/androidTest/java/com/shiyinghan/mqtt/android/MqttV3Receiver.java b/mqtt/src/androidTest/java/com/shiyinghan/mqtt/android/MqttV3Receiver.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 2015, 2016 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android;
 
 import java.io.PrintStream;
diff --git a/mqtt/src/androidTest/java/com/shiyinghan/mqtt/android/TestProperties.java b/mqtt/src/androidTest/java/com/shiyinghan/mqtt/android/TestProperties.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 2015, 2016 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android;
 
 import android.content.Context;
diff --git a/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/AlarmPingSender.java b/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/AlarmPingSender.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 2014 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android.service;
 
 import android.annotation.SuppressLint;
diff --git a/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/DatabaseMessageStore.java b/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/DatabaseMessageStore.java
@@ -1,18 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 1999, 2014 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- *   Contributors:
- *     James Sutton - Removing SQL Injection vunerability (bug 467378)
- */
 package com.shiyinghan.mqtt.android.service;
 
 import java.util.Iterator;
diff --git a/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MessageStore.java b/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MessageStore.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 1999, 2014 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android.service;
 
 import java.util.Iterator;
diff --git a/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttConstants.java b/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttConstants.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 1999, 2016 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android.service;
 
 /**
diff --git a/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttService.java b/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttService.java
@@ -1,18 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 1999, 2016 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- *   James Sutton - isOnline Null Pointer (bug 473775)
- */
 package com.shiyinghan.mqtt.android.service;
 
 import java.util.Map;
diff --git a/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttTokenAndroid.java b/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttTokenAndroid.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 1999, 2014 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android.service;
 
 import android.os.Handler;
diff --git a/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttTraceCallback.java b/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttTraceCallback.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 1999, 2014 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android.service;
 
 import android.util.Log;
diff --git a/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttTraceHandler.java b/mqtt/src/main/java/com/shiyinghan/mqtt/android/service/MqttTraceHandler.java
@@ -1,15 +1,3 @@
-/*******************************************************************************
- * Copyright (c) 1999, 2014 IBM Corp.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution. 
- *
- * The Eclipse Public License is available at 
- *    http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at 
- *   http://www.eclipse.org/org/documents/edl-v10.php.
- */
 package com.shiyinghan.mqtt.android.service;
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -71,4 +71,5 @@ dependencies {`
`71`	`71`	`androidTestImplementation deps.espresso`
`72`	`72`
`73`	`73`	`implementation project(path: ':mqtt')`
	`74`	`+// implementation 'com.github.shiyinghan:MqttAndroid:1.0.0'`
`74`	`75`	`}`