Merge pull request #1 from evolv-ai/preparing-release-v0.5.1

preparing release of version 0.5.1

Author: FrazerBayley

README.md

@@ -5,13 +5,29 @@
    **Participant:** The end user of the application, the individual who's actions are being recorded in the experiment.
    **Allocation:** The set of configurations that have been given to the participant, the values that are being
    experimented against.
+   
+   
+### Import the SDK
+
+1. Import the Ascend SDK.
+
+    ```xml
+        <dependency>
+          <groupId>ai.evolv</groupId>
+          <artifactId>ascend-sdk</artifactId>
+          <version>0.5.1</version>
+        </dependency>
+    ```
 
 ### Client Initialization
 
 1. Build an AscendConfig instance.
     ```java
-       AscendConfig config = AscendConfig.builder(<environment_id>).build();
+       AscendConfig config = AscendConfig.builder(<environment_id>, <http_client>).build();
     ```
+    
+    *Note: The SDK uses a standard interface for the http backend see [HttpClient.](https://github.com/evolv-ai/ascend-java-sdk/blob/master/src/main/java/ai/evolv/HttpClient.java). 
+    When configuring the client you must specify what implementation of HttpClient to use (or implement your own).*
 
 2. Initialize the AscendClient.
     ```java
@@ -90,10 +106,10 @@ custom allocation store to the client when you build the AscendConfig.
 
 1. Supply the allocation store to the client.
     ```java
-       AscendConfig config = AscendConfig.Builder(<environment_id>)
+       AscendConfig config = AscendConfig.builder(<environment_id>, <http_client>)
            .setAscendAllocationStore(<custom_store>)
            .build();
-       AscendClient client = AscendClient.init(config);
+       AscendClient client = AscendClientFactory.init(config);
    ```
 
 ### Optional Configurations

build.gradle

@@ -6,7 +6,7 @@ plugins {
 
 group = "ai.evolv"
 archivesBaseName = "ascend-sdk"
-version = "0.5.0"
+version = "0.5.1"
 
 sourceCompatibility = 1.8
 
@@ -15,28 +15,17 @@ repositories {
     mavenCentral()
 }
 
-ext.libraries = [:]
-
-libraries.required = [
-        'com.google.code.gson:gson:2.8.5',
-        'org.slf4j:slf4j-api:1.7.26'
-]
-
-libraries.optional = [
-        'com.squareup.okhttp3:okhttp:3.14.0',
-        'org.asynchttpclient:async-http-client:2.0.38'
-]
+dependencies {
+    implementation 'com.google.code.gson:gson:2.8.5'
+    implementation 'org.slf4j:slf4j-api:1.7.26'
 
-libraries.test = [
-        'log4j:log4j:1.2.17',
-        'org.apache.logging.log4j:log4j-slf4j-impl:2.11.2',
-        'org.mockito:mockito-core:2.1.0',
-        'junit:junit:4.12'
-]
+    compileOnly 'com.squareup.okhttp3:okhttp:3.14.0'
+    compileOnly 'org.asynchttpclient:async-http-client:2.0.38'
 
-dependencies {
-    implementation libraries.required, libraries.optional, libraries.test
-    testImplementation libraries.test
+    testImplementation 'log4j:log4j:1.2.17'
+    testImplementation 'org.apache.logging.log4j:log4j-slf4j-impl:2.11.2'
+    testImplementation 'org.mockito:mockito-core:2.1.0'
+    testImplementation 'junit:junit:4.12'
 }
 
 task sourcesJar(type: Jar, dependsOn: classes) {