Skip to content

Commit

Permalink
Added Quickstart section to README (closes #43)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexanderdean committed Dec 27, 2014
1 parent 9662a64 commit dff7310
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Version 0.2.0 (2014-12-XX)
Added dedicated Vagrant setup (#40)
Bumped Core version to 0.2.0 (#42)
Added warning that Version.java is auto-generated (#45)
Added Quickstart section to README (#43)
Updated CHANGELOG with missing tickets (#41)

Version 0.1.3 (2014-11-25)
Expand Down
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,19 @@

Add analytics to your Java software with the **[Snowplow] [snowplow]** event tracker for **[Android] [snowplow]**.

With this tracker you can collect event data from your Java-based desktop and server apps, servlets and games. Supports JDK6+.
With this tracker you can collect event data from your Android-based applications, games or frameworks.

## Quickstart

Assuming git, [Vagrant] [vagrant-install] and [VirtualBox] [virtualbox-install] installed:

```bash
host$ git clone https://github.com/snowplow/snowplow-android-tracker.git
host$ cd snowplow-android-tracker
host$ vagrant up && vagrant ssh
guest$ cd /vagrant
guest$ ./gradlew build
```

## Find out more

Expand All @@ -32,6 +44,9 @@ limitations under the License.

[snowplow]: http://snowplowanalytics.com

[vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
[virtualbox-install]: https://www.virtualbox.org/wiki/Downloads

[techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
[setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
[roadmap-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png
Expand Down
2 changes: 1 addition & 1 deletion vagrant/up.guidance
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
To get started:
vagrant ssh
cd /vagrant
./gradlew test
./gradlew build

0 comments on commit dff7310

Please sign in to comment.