Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/petoem/mixpanel-crystal

Track events on Mixpanel with Crystal
https://github.com/petoem/mixpanel-crystal

analytics crystal mixpanel

Last synced: 9 days ago
JSON representation

Track events on Mixpanel with Crystal

Awesome Lists containing this project

README

        

# mixpanel-crystal

[![GitHub release](https://img.shields.io/github/release/petoem/mixpanel-crystal.svg?style=flat-square)](https://github.com/petoem/mixpanel-crystal/releases)
[![Travis](https://img.shields.io/travis/petoem/mixpanel-crystal.svg?style=flat-square)](https://travis-ci.org/petoem/mixpanel-crystal)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/petoem/mixpanel-crystal/blob/master/LICENSE)

**mixpanel-crystal** is a library for tracking events on Mixpanel from your crystal applications.

## Installation

Add this to your application's `shard.yml`:

```yaml
dependencies:
mixpanel:
github: petoem/mixpanel-crystal
```

## Usage

```crystal
require "mixpanel"

# Use Mixpanel::Tracker to track events in your application. To track an event, use
tracker = Mixpanel::Tracker.new "YOUR_TOKEN"
tracker.track "Signup", Mixpanel::Event::Properties{"username" => "Pino", "Age" => 2}
```

You can also take a look at the [specs](https://github.com/petoem/mixpanel-crystal/blob/master/spec/mixpanel_spec.cr) for more examples or generate documentation with `crystal docs` command.

## Contributing

1. Fork it ( https://github.com/petoem/mixpanel-crystal/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

- [petoem](https://github.com/petoem) Michael Petö - creator, maintainer