Update README.md

README.md

@@ -1,28 +1,67 @@
 # SecureTime (Android Roughtime library)
+[![](https://jitpack.io/v/tajchert/securetime.svg)](https://jitpack.io/#tajchert/securetime)
+[![](https://jitci.com/gh/tajchert/securetime/svg)](https://jitci.com/gh/tajchert/securetime)
 
 Library for easy usage of [Roughtime protocol](https://roughtime.googlesource.com/roughtime) on Android (with Rx). This is based on Java library [Nearenough by int08h](https://github.com/int08h/nearenough) - kudos!
 
-# Why Roughtime, instead of NTP?
+### Usage (WIP)
+
+```kotlin
+  Observable.fromCallable {
+      roughtimeHelper!!.getTime()
+  }
+  .subscribeOn(Schedulers.io())
+  .observeOn(AndroidSchedulers.mainThread())
+  .subscribe(
+      { result ->
+          val midpoint = result.first
+          val radiousOfUncertanity = result.second
+          val localTimeDiffMilliseconds = result.third
+          val localTimeDiffSeconds = TimeUnit.MILLISECONDS.toSeconds(result.third)
+          //Use result for something
+          Timber.d("Result from server, midpoint: $midpoint, radius(ms): $radiousOfUncertanity, localDiff (ms): $localTimeDiffMilliseconds")
+      },
+      {
+          Timber.e(it)
+      })
+```
+
+### Dependency
+
+Use Jitpack.io, with Gradle:
+```gradle
+    implementation 'com.github.tajchert:securetime:0.0.1'
+```
+Add Jitpack in your root build.gradle at the end of repositories:
+```gradle
+	allprojects {
+		repositories {
+			...
+			maven { url "https://jitpack.io" }
+		}
+	}
+```
+
+### Why Roughtime, instead of NTP?
 
 * Secured - responses are signed by server, contains nonce send by client.
 * Scalable - much better handling on backend (signing and batches), compact payload of network packages.
 * Doesn't allow amplification of DDOS attacts.
 
-# Why not?
+### Why not?
 
 * It is not millisecond accurate - accuracy is around 1 second.
 
 [Much more details on Roughtime](https://int08h.com/post/to-catch-a-lying-timeserver/)
 
-# Android App
+### Sample Android App
 
 <p align="center">
   <img src="https://github.com/tajchert/securetime/blob/master/assets/android_app_screen.png?raw=true" width="350" title="Android App">
   <img src="https://github.com/tajchert/securetime/blob/master/assets/roughtime.png?raw=true" alt="Command line">
 </p>
-Known issue: some requests fail to get response in 5 sec. timeframe. Extending it doesn't seem to solve problem, might be a server issue.
 
-# Roughtime servers
+### Roughtime servers
 
 App is hooked to `roughtime.cloudflare.com:2002`, second known running server is `roughtime.int08h.com:2002`.
 
@@ -33,7 +72,9 @@ App is hooked to `roughtime.cloudflare.com:2002`, second known running server is
   * `Base64 = AW5uAoTSTDfG5NfY1bTh08GUnOqlRb+HVhbJ3ODJvsE=`
   * `hex = 016e6e0284d24c37c6e4d7d8d5b4e1d3c1949ceaa545bf875616c9dce0c9bec1`
 
-# Roadmap for this library (help wanted)
+### Known issues
+Some requests fail to get response in 5 sec. timeframe. Extending it doesn't seem to solve problem - might be a server issue as it seems to be random and results in Timeout.
+### Roadmap for this library (help wanted)
 * Separate Rx extension to separate library module
 * Retry mechanism
 * Allow using multiple servers on one `getTime()`