Merge branch 'release/v0.1.0'

.travis.yml

@@ -0,0 +1,9 @@
+language: scala
+scala:
+   - 2.11.8
+jdk:
+   - oraclejdk8
+script:
+  - sbt ++$TRAVIS_SCALA_VERSION --warn update compile test
+
+sudo: false

README.md

@@ -2,6 +2,8 @@
 
 _Typesafe Config wrapped in a [`Dynamic`][dsd] blanket._
 
+[![Build Status](https://travis-ci.org/ElderResearch/ssc.svg?branch=develop)](https://travis-ci.org/ElderResearch/ssc)
+
 ## Overview
 
 [_Typesafe Config_][tc] is about as perfect as an application configuration system can be. [HOCON][hocon] is fantastic to work with, and the underlying Java implementation is both robust and consistent.
@@ -36,10 +38,12 @@ _Simple Scala Config_ is able to do this via the use of Scala's [`Dynamic`][dsd]
 
 ## Using
 
-The library is published via XXX. Add this to your sbt build definitions:
+The library is published via bintray. Add this to your sbt build definitions:
 
 ```scala
-libraryDependencies += "com.elderresearch" %% "ssc" % "0.1.0-SNAPSHOT"
+resolvers += "ERI OSS" at "http://dl.bintray.com/elderresearch/OSS"
+
+libraryDependencies += "com.elderresearch" %% "ssc" % "0.1.0"
 ```
 
 It will transitively pull in the Typesafe Config and Scala Reflection libraries:
@@ -49,6 +53,8 @@ It will transitively pull in the Typesafe Config and Scala Reflection libraries:
 "org.scala-lang" %  "scala-reflect"  % scalaVersion.value
 ```
 
+Note: **Requires Java 8**, as does _Typesafe Config_ >= `1.3.0`
+
 ## Examples
 
 ### Basic

build.sbt

@@ -2,14 +2,26 @@ name := "Simple Scala Config"
 
 moduleName := "ssc"
 
-version := "0.1.0-SNAPSHOT"
+version := "0.1.0"
 
 organization := "com.elderresearch"
 
+licenses := Seq(("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0.html")))
+
 scalaVersion := "2.11.8"
 
+scalacOptions += "-target:jvm-1.8"
+
 libraryDependencies ++= Seq(
   "org.scala-lang" %  "scala-reflect"  % scalaVersion.value,
   "com.typesafe" % "config" % "1.3.0",
   "org.scalatest" %% "scalatest" % "2.2.6" % "test"
 )
+
+publishMavenStyle := false
+
+bintrayOrganization := Some("elderresearch")
+
+bintrayRepository := "OSS"
+
+bintrayReleaseOnPublish in ThisBuild := false

notes/0.1.0.markdown

@@ -0,0 +1,22 @@
+## Initial Release
+
+* Supports field-dereference syntax for _Typesafe Config_ lookups, supporting types `T` and `Option[T]` where `T` is `{Boolean|Int|Double|Long|Float|String|Duration|Path|File|Config|AnyRef}`.
+
+
+    `object MyConfig extends SSConfig()`  
+    `val tmp = MyConfig.myapp.tempdir.as[Path]`  
+    `val runtime = MyConfig.java.runtime.name.as[String]`  
+    `val timeout = MyConfig.akka.actor.'creation-timeout'.as[Duration].getSeconds`  
+    `val debugMode = MyConfig.app.debug.asOption[Boolean].getOrElse(false)`  
+
+
+ * Allows nested configuration via optional path parameter:
+
+    `object AkkaConfig extends SSConfig("akka")`  
+    `val akkaVersion = AkkaConfig.version.as[String]`  
+    `val timeout = AkkaConfig.actor.`creation-timeout`.as[Duration].getSeconds`    
+
+* Allows custom config loading via optional `Config` parameter:
+
+    `val props = new SSConfig(ConfigFactory.load("myprops.properties"))`  
+    `val version = props.version.as[String]`  

notes/about.markdown

@@ -0,0 +1 @@
+[Simple Scala Config](https://github.com/ElderResearch/ssc) is [Typesafe Config](https://github.com/typesafehub/config) wrapped in a [`Dynamic`](http://www.scala-lang.org/api/2.11.8/#scala.Dynamic) Scala blanket. It is an extremely thin wrapper (less than 100 SLOC), allowing retrieval of configuration values using field-dereference syntax.

project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("me.lessis" % "bintray-sbt" % "0.3.0")