Prepared for release

Author: aldemirenes

CHANGELOG

@@ -1,3 +1,15 @@
+Version 0.6.0 (2017-09-14)
+--------------------------
+Remove logging section from example config (#115)
+Add message when requiring that the Kinesis stream exist fails (#113)
+Refactor to change purpose of the S3Emitter class (#110)
+Support AT_TIMESTAMP as initial position (#109)
+Move configuration example to an examples top-level folder (#107)
+Configuration decoding with pureconfig (#105)
+Stop making the assembly jar executable (#104)
+Rename to Snowplow S3 Loader (#66)
+Add NSQ as a stream source (#64)
+
 Version 0.5.0 (2017-06-30)
 --------------------------
 Add a newline at the end of a gzipped tsv file (#49)

README.md

@@ -1,12 +1,12 @@
 # Snowplow S3 Loader
 
 [![Build Status][travis-image]][travis]
-[![Release][release-image]][releases] 
+[![Release][release-image]][releases]
 [![License][license-image]][license]
 
 ## Overview
 
-The Snowplow S3 Loader consumes records from an [Amazon Kinesis][kinesis] stream, and writes them to S3.
+The Snowplow S3 Loader consumes records from an [Amazon Kinesis][kinesis] stream or [NSQ][nsq] topic, and writes them to S3.
 
 There are 2 file formats supported:
  * LZO
@@ -49,9 +49,9 @@ NOTE: These are already installed in the Vagrant quickstart environment.
 The Snowplow S3 Loader has the following command-line interface:
 
 ```
-snowplow-s3-loader: Version 0.5.0
+snowplow-s3-loader: Version 0.6.0
 
-Usage: java -jar snowplow-s3-loader.jar [options]
+Usage: snowplow-s3-loader [options]
 
 --config <filename>
 ```
@@ -62,17 +62,17 @@ Create your own config file:
 
 ```bash
 guest$ cd /vagrant
-guest$ cp src/main/resources/config.hocon.sample my.conf
+guest$ cp examples/config.hocon.sample my.conf
 ```
 
 You will need to edit all fields in the config.  Consult [this portion][config] of the setup guide on how to fill in the fields.
 
 Next, start the sink, making sure to specify your new config file:
 
 ```bash
-guest$ sbt "run --config my.conf"
+guest$ java -jar snowplow-s3-loader-0.6.0.jar --config my.conf
 ```
-    
+
 ## Find out more
 
 | Technical Docs             | Setup Guide          | Roadmap & Contributing |
@@ -96,13 +96,14 @@ limitations under the License.
 [travis-image]: https://travis-ci.org/snowplow/snowplow-s3-loader.png?branch=master
 [travis]: http://travis-ci.org/snowplow/snowplow-s3-loader
 
-[release-image]: http://img.shields.io/badge/release-0.5.0-blue.svg?style=flat
+[release-image]: http://img.shields.io/badge/release-0.6.0-blue.svg?style=flat
 [releases]: https://github.com/snowplow/snowplow-s3-loader/releases
 
 [license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
 [license]: http://www.apache.org/licenses/LICENSE-2.0
 
 [kinesis]: http://aws.amazon.com/kinesis/
+[nsq]: http://nsq.io/
 [snowplow]: http://snowplowanalytics.com
 [hadoop-lzo]: https://github.com/twitter/hadoop-lzo
 [protobufs]: https://github.com/google/protobuf/
@@ -113,9 +114,9 @@ limitations under the License.
 [vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
 [virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
 
-[setup]: https://github.com/snowplow/snowplow/wiki/kinesis-lzo-s3-sink-setup
-[config]: https://github.com/snowplow/snowplow/wiki/kinesis-lzo-s3-sink-setup#configuration
-[techdocs]: https://github.com/snowplow/snowplow/wiki/kinesis-lzo-s3-sink
+[setup]: https://github.com/snowplow/snowplow/wiki/snowplow-s3-loader-setup
+[config]: https://github.com/snowplow/snowplow/wiki/snowplow-s3-loader-setup#configuration
+[techdocs]: https://github.com/snowplow/snowplow/wiki/s3-loader
 
 [techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
 [setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png

build.sbt

@@ -15,8 +15,8 @@
 lazy val root = project.in(file("."))
   .settings(
     name        := "snowplow-s3-loader",
-    version     := "0.5.0",
-    description := "S3 Loader"
+    version     := "0.6.0",
+    description := "Load the contents of a Kinesis stream or NSQ topic to S3"
   )
   .settings(BuildSettings.buildSettings)
   .settings(BuildSettings.sbtAssemblySettings)
@@ -46,4 +46,4 @@ lazy val root = project.in(file("."))
     )
   )
 
-shellPrompt := { _ => "s3-loader> " }
+shellPrompt := { _ => "s3-loader> " }

project/BuildSettings.scala

@@ -37,6 +37,7 @@ object BuildSettings {
     "-Yno-adapted-args",
     "-Ywarn-dead-code",
     "-Ywarn-numeric-widen",
+    "-Ywarn-unused-import",
     "-Xfuture",
     "-Xlint"
   )