74 lines
3.4 KiB
Markdown
74 lines
3.4 KiB
Markdown
# Ruby Analytics for Snowplow
|
|
[](http://badge.fury.io/rb/snowplow-tracker)
|
|
[](https://travis-ci.org/snowplow/snowplow-ruby-tracker)
|
|
[](https://codeclimate.com/github/snowplow/snowplow-ruby-tracker)
|
|
[](https://coveralls.io/r/snowplow/snowplow-ruby-tracker)
|
|
[![License][license-image]][license]
|
|
|
|
## Overview
|
|
|
|
Add analytics to your Ruby and Rails apps and gems with the **[Snowplow] [snowplow]** event tracker for **[Ruby] [ruby]**.
|
|
|
|
With this tracker you can collect event data from your **[Ruby] [ruby]** applications, **[Ruby on Rails] [rails]** web applications and **[Ruby gems] [rubygems]**.
|
|
|
|
## Quickstart
|
|
|
|
Assuming git, **[Vagrant] [vagrant-install]** and **[VirtualBox] [virtualbox-install]** installed:
|
|
|
|
```bash
|
|
host$ git clone https://github.com/snowplow/snowplow-ruby-tracker.git
|
|
host$ cd snowplow-ruby-tracker
|
|
host$ vagrant up && vagrant ssh
|
|
guest$ cd /vagrant
|
|
guest$ gem install bundler
|
|
guest$ bundle install
|
|
guest$ rspec
|
|
```
|
|
|
|
## Publishing
|
|
|
|
```bash
|
|
host$ vagrant push
|
|
```
|
|
|
|
## Find out more
|
|
|
|
| Technical Docs | Setup Guide | Roadmap | Contributing |
|
|
|---------------------------------|---------------------------|-------------------------|-----------------------------------|
|
|
| ![i1] [techdocs-image] | ![i2] [setup-image] | ![i3] [roadmap-image] | ![i4] [contributing-image] |
|
|
| **[Technical Docs] [techdocs]** | **[Setup Guide] [setup]** | **[Roadmap] [roadmap]** | **[Contributing] [contributing]** |
|
|
|
|
## Copyright and license
|
|
|
|
The Snowplow Ruby Tracker is copyright 2013-2016 Snowplow Analytics Ltd.
|
|
|
|
Licensed under the **[Apache License, Version 2.0] [license]** (the "License");
|
|
you may not use this software except in compliance with the License.
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
[license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
|
|
[license]: http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
[ruby]: https://www.ruby-lang.org/en/
|
|
[rails]: http://rubyonrails.org/
|
|
[rubygems]: https://rubygems.org/
|
|
|
|
[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
|
|
[contributing-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png
|
|
|
|
[techdocs]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker
|
|
[setup]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Setup
|
|
[roadmap]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Roadmap
|
|
[contributing]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Contributing
|