Skip to content

Commit

Permalink
Prepared for release
Browse files Browse the repository at this point in the history
  • Loading branch information
jbeemster committed May 24, 2020
1 parent 1263d50 commit bc4bc94
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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

0 comments on commit bc4bc94

Please sign in to comment.