Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added a banner, fixes #2.
  • Loading branch information
marcbouchenoire committed Aug 9, 2017
1 parent 17dc4a8 commit 16bf408
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
Binary file added Docs/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# Trekker

[![Build Status](https://travis-ci.org/awkward/Tatsi.svg?branch=master)](https://travis-ci.org/awkward/Tatsi)
[![Contact](https://img.shields.io/badge/contact-madeawkward-blue.svg?style=flat)](https://twitter.com/madeawkward)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
<h1 align="center">
<img src="Docs/banner.png">
Trekker<br>
<p align="center">
<a href="https://travis-ci.org/awkward/Trekker">
<img src="https://travis-ci.org/awkward/Trekker.svg?branch=master" alt="Build Status">
</a>
<a href="https://twitter.com/madeawkward">
<img src="https://img.shields.io/badge/contact-madeawkward-blue.svg?style=flat" alt="Contact">
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT">
</a>
</p>
</h1>

A wrapper to easily swap out different analytics services or to support multiple analytics services at once. Trekker works best with event based analytics services like Mixpanel, Amplitude, Firebase, and Answers by Crashlytics.

Expand Down Expand Up @@ -37,7 +47,7 @@ Hi, we're <a href="https://awkward.co/" target="_blank">Awkward</a>. We used man

TrekkerService is the protocol that is implemented for every analytics service that is fed into Trekker.

Adding a Trekker is simple.
Adding a Trekker is simple.
First add the framework of the analytics service to your app. There are ready build implementations for some services, see the example services folder.

If the service doesn't have a ready implementation, a new subclass of NSObject should be made. It should implement the TrekkerService protocol. This requires implementing the following properties:
Expand Down

0 comments on commit 16bf408

Please sign in to comment.