Readme changes

Author: jonsamwell

README.md

@@ -15,6 +15,9 @@ Working demo https://plnkr.co/edit/OgvZ09iYO64VoXHLRGQa?p=preview
   - [Examples](#examples)
   - [Usage](#usage)
 - [Configuration](#configuration)
+  - [Endpoint Url](#config-endpointurl)
+  - [Batch Endpoint Url](#config-batchurl)
+  - [Enabled](#config-enabled)
 
 ## <a name="get-started"></a> Get Started
 
@@ -33,6 +36,7 @@ There isn't much too visually see but you will want to open up the network tab o
 ### <a name="usage"></a> Usage
 `NgxHttpBatcherModule` should be registered in the `AppModule` imports.  This module relies on the Angular HttpModule so ensure that is also imported.
 
+The below bit of code is everything you need to get going.  However, I'll explain it below.
 
 ```javascript
 import { BrowserModule } from "@angular/platform-browser";
@@ -50,8 +54,8 @@ import { AppComponent } from "./app.component";
 export function httpBatchConfigurationFactory() {
   return new HttpBatchConfigurationCollection([
     new HttpBatchConfiguration({
-      rootEndpointUrl: "https://my.service.com",
-      batchEndpointUrl: "https://my.service.com/$batch"
+      rootEndpointUrl: "https://api.myservice.com",
+      batchEndpointUrl: "https://api.myservice.com/$batch"
     })]);
 };
 
@@ -76,4 +80,53 @@ export function httpBatchConfigurationFactory() {
 export class AppModule { }
 ```
 
+Then you can just use the Http service as you normally would safe in the knowlegde that requests to you batchable service (configured above) will be batched.
+
+```javascript
+import { Component } from "@angular/core";
+import { Http } from "@angular/http";
+
+@Component({
+  selector: "app-root",
+  templateUrl: "./app.component.html",
+  styleUrls: ["./app.component.css"]
+})
+export class AppComponent {
+  public somedata: string[];
+  public otherdata: string[];
+
+  public constructor(private http: Http) {
+    http.get("https://api.myservice.com/somedata")
+        .subscribe(response => this.somedata = response.json());
+    http.get("https://api.myservice.com/otherdata/123-456")
+        .subscribe(response => this.otherdata = response.json());
+    http.put("https://api.myservice.com/jobs", { id: 1, name: "Angular Wizard" })
+        .subscribe();
+  }
+}
+```
+
+
+### <a name="configuration"></a> Configuration
+
+Below are all the configuration options for a single batch endpoint.  Note that you can have as many batch endpoints as you want but you would need a seperate configuraiton object for each one.
+
+### <a name="config-endpointurl"></a> Endpoint Url
+The root endpoint url which is used to determine if the http call is destinted to an endpoint that can be batched.
+For example you endpoint might be:
+
+```https://api.myservice.com```
+
+Calls to ```https//api.myservice.com/users``` or ```https//api.myservice.com/users/fdfkhdf-3432e23wd/friends?limit=10&from=0``` would be batched.
+Calls to ```https://qa.myservice.com/bugs``` would not be batched as the subdomain are different.
+
+### <a name="config-batchurl"></a> Batch Endpoint Url
+The url of the exposed batch endpoint that is associated with the service defined in rootEndpointUrl.
+
+For example
+
+```https://api.myservice.com/$batch```
+
+### <a name="config-enabled"></a> Enabled
+This optional parameter defaults to true.  If false calls that would normally be batched to this endpoint will just be passed through as normal HTTP calls.