Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 1.25 KB

README.md

File metadata and controls

60 lines (46 loc) · 1.25 KB

ReferThis Build Status Gem Version

Installation

referthis can be installed via the execution of the following command:

gem install referthis

The backend can be setup via the execution of the following command:

ReferThis.setup

Usage

Transmission

ReferThis.url(endpoints¹, user_id, base_url, user_name[, optional²])

¹object structure

{'email_address'=>value, 'phone_number'=>value}

²defaults to

{:app_name=>Rails.application.class.to_s.split('::').first}

Subsequently, optional[:body] defaults to

referrer_name + ' has referred you to ' + optional[:app_name] + '! You might be interested in checking out the following: ' + url + '/'

Analysis

ReferThis.clicked_through_rate(email¹,sms¹,overall²)

¹defaults to

false

²defaults to

true

In Production

http://referthisdemo.herokuapp.com

Versioning

http://semver.org