Merge pull request #124 from hmrc/docs

Update docs for StringContext ops

README.md

@@ -2,6 +2,7 @@ http-verbs
 ==========
 
 
+![](https://img.shields.io/github/v/release/hmrc/http-verbs)
 
 http-verbs is a Scala library providing an interface to make asynchronous HTTP calls.
 
@@ -16,9 +17,13 @@ It encapsulates some common concerns for calling other HTTP services on the HMRC
 * Auditing
 * Logging
 * Propagation of common headers
-* Response handling, converting failure status codes into a consistent set of exceptions - allows failures to be * automatically propagated to the caller
+* Response handling, converting failure status codes into a consistent set of exceptions - allows failures to be automatically propagated to the caller
 * Request & Response de-serializations
 
+## Migration
+
+See [CHANGELOG](https://github.com/hmrc/http-verbs/blob/master/CHANGELOG.md) for changes and migrations.
+
 ## Adding to your build
 
 In your SBT build add:
@@ -36,9 +41,12 @@ Examples can be found [here](https://github.com/hmrc/http-verbs/blob/master/http
 
 ### URLs
 
-URLs can be supplied as either `java.net.URL` or `String`. We recommend supplying `java.net.URL` for correct escaping of query and path parameters. A [URL interpolator](https://sttp.softwaremill.com/en/latest/model/uri.html) has been implicitly provided for convenience.
+URLs can be supplied as either `java.net.URL` or `String`. We recommend supplying `java.net.URL` for correct escaping of query and path parameters. A [URL interpolator](https://sttp.softwaremill.com/en/latest/model/uri.html) has been provided for convenience.
+
+
+```scala
+import uk.gov.hmrc.http.StringContextOps
 
-```
 url"http://localhost:8080/users/${user.id}?email=${user.email}"
 ```
 

http-verbs-common/src/main/scala/uk/gov/hmrc/http/HttpClient.scala

@@ -16,4 +16,4 @@
 
 package uk.gov.hmrc.http
 
-trait HttpClient extends HttpGet with HttpPut with HttpPost with HttpDelete with HttpPatch
+trait HttpClient extends HttpGet with HttpPut with HttpPost with HttpDelete with HttpPatch

http-verbs-common/src/main/scala/uk/gov/hmrc/http/package.scala

@@ -21,7 +21,8 @@ import java.net.URL
 import sttp.model.UriInterpolator
 
 package object http {
-  implicit class StringContextOps(sc: StringContext){
-    def url(args: Any*) : URL = UriInterpolator.interpolate(sc, args: _*).toJavaUri.toURL
+  implicit class StringContextOps(val sc: StringContext) extends AnyVal {
+    def url(args: Any*): URL =
+      UriInterpolator.interpolate(sc, args: _*).toJavaUri.toURL
   }
 }