From bc4bc94353a651800e5d6fe357093f567edc0dc4 Mon Sep 17 00:00:00 2001 From: jbeemster Date: Thu, 21 May 2020 12:38:25 +0200 Subject: [PATCH] Prepared for release --- CHANGELOG | 6 ++++++ README.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) diff --git a/CHANGELOG b/CHANGELOG index 3a6bbb5..56b79f0 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,9 @@ +Version 0.4.0 (2020-05-24) +-------------------------- +Upgrade project to use go.mod and latest dependencies (#21) +Add support for passing in custom contexts (#22) +Update Copyright to 2016-2020 (#23) + Version 0.3.0 (2018-09-05) -------------------------- Add ability to set custom IP Address (#18) diff --git a/README.md b/README.md index b0343a4..aef9645 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,37 @@ The Snowplow Tracking CLI is a native app to make it easy to send an event to Snowplow from the command line. Use this to embed Snowplow tracking into your shell scripts and terminal sessions. +## Quick start + +Assuming git, [Vagrant][vagrant-url] and [VirtualBox][virtualbox-url] are installed: + +```bash + host> git clone https://github.com/snowplow/snowplow-tracking-cli + host> cd snowplow-tracking-cli + host> vagrant up && vagrant ssh +guest> cd /opt/gopath/src/github.com/snowplow/snowplow-tracking-cli +guest> make test +guest> make +``` + +**Note:** You do not have to use Vagrant if you already have Golang installed on your host. + +To remove all build files: + +```bash +guest> make clean +``` + +To format the golang code in the source directory: + +```bash +guest> make format +``` + +**Note:** Always run `make format` before submitting any code. + +**Note:** The `make test` command also generates a code coverage file which can be found at `build/coverage/coverage.html`. + ## Installing You can download the binary for Linux and Windows directly from Bintray: @@ -36,6 +67,7 @@ where: * `--schema` is a schema URI, most likely of the form `iglu:...` * `--json` is a (non-self-describing) JSON, of the form `{ ... }` * `--ipaddress` is optional. It defaults to an empty string +* `--contexts` is optional. It defaults to an empty JSON array `[]` The idea here is that you can either send in a [**self-describing JSON**][sd-json], or pass in the constituent parts (i.e. a regular JSON plus a schema URI) and the Snowplow Tracking CLI will construct the final self-describing JSON for you. @@ -114,3 +146,6 @@ limitations under the License. [linux-binary]: https://bintray.com/snowplow/snowplow-generic/download_file?file_path=snowplow_tracking_cli_0.4.0_linux_amd64.zip [windows-binary]: https://bintray.com/snowplow/snowplow-generic/download_file?file_path=snowplow_tracking_cli_0.4.0_windows_amd64.zip [darwin-binary]: https://bintray.com/snowplow/snowplow-generic/download_file?file_path=snowplow_tracking_cli_0.4.0_darwin_amd64.zip + +[vagrant-url]: http://docs.vagrantup.com/v2/installation/index.html +[virtualbox-url]: https://www.virtualbox.org/wiki/Downloads