Skip to content

Commit

Permalink
Merge pull request #4 from zumba/readme-badges
Browse files Browse the repository at this point in the history
Adding badges and a small description to readme
  • Loading branch information
jrbasso committed Apr 28, 2016
2 parents f2366e5 + 1107912 commit 97adc41
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
# amplitude-php
Implementation of Amplitude's API in PHP
# Zumba amplitude-php

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
[![Build Status](https://img.shields.io/travis/zumba/amplitude-php/master.svg?style=flat-square)](https://travis-ci.org/zumba/amplitude-php)
[![Code Coverage](https://img.shields.io/coveralls/zumba/amplitude-php/master.svg)](https://coveralls.io/github/zumba/amplitude-php)
[![Scrutinizer](https://scrutinizer-ci.com/g/zumba/amplitude-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/zumba/amplitude-php/)

This is a moderately thin PHP API for [Amplitude](https://amplitude.com/), powerful enough to do what you need without getting in the way. Designed to work well in 2 main scenarios:

* **Same user & Amplitude App** - When you are tracking possibly multiple events, all for the same user, all for the same Amplitude app. This library provides a singleton method that allows persisting the user and API key.
* **Multiple Users / Same or Different Amplitude Apps** - For times you may need to log multiple events for a lot of different users, possibly using different amplitude apps.

# Work in Progress

We're still working documenting all the things and working out any kinks, but should have version 1.0.0 ready soon, stay tooned!

0 comments on commit 97adc41

Please sign in to comment.