diff --git a/README.md b/README.md index 10343f2..254e3ca 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ # convert A Scala library for handling conversions between types by throwing exceptions or returning Options containing the results + +[![Build Status](https://travis-ci.org/NthPortal/convert.svg?branch=master)](https://travis-ci.org/NthPortal/convert) +[![Coverage Status](https://coveralls.io/repos/github/NthPortal/convert/badge.svg?branch=master)](https://coveralls.io/github/NthPortal/convert?branch=master) +[![Maven Central](https://img.shields.io/maven-central/v/com.nthportal/convert_2.12.svg)](https://mvnrepository.com/artifact/com.nthportal/convert_2.12) +[![Versioning](https://img.shields.io/badge/versioning-semver%202.0.0-blue.svg)](http://semver.org/spec/v2.0.0.html) +[![Docs](https://www.javadoc.io/badge/com.nthportal/convert_2.12.svg?color=blue&label=docs)](https://www.javadoc.io/doc/com.nthportal/convert_2.12) + + +## Add as a Dependency + +### SBT (Scala 2.11 and 2.12) + +```sbtshell +"com.nthportal" %% "convert" % "0.1.0" +``` + +### Maven + +**Scala 2.12** + +```xml + + com.nthportal + convert_2.12 + 0.1.0 + +``` + +**Scala 2.11** + +```xml + + com.nthportal + convert_2.11 + 0.1.0 + +```