Project

shortee

0.0
No commit activity in last 3 years
No release in over 3 years
Shortee message parser and specification for tracking events.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0
 Project Readme

Shortee

Shortee is a gem for parsing small messages which use the Shortee Syntax.

The Shortee Syntax enables a user to record events that they wish to track, examples being business mileage, calories eaten, miles cycled, etc.

The specification for a Shortee Syntax can be found at https://github.com/JeremyNevill/shortee/blob/master/Shortee_specification.md

To view a website using Shortee in production visit http://firework.com

Installation

Add this line to your application's Gemfile:

gem 'shortee'

And then execute:

$ bundle

Or install it yourself as:

$ gem install shortee

Usage

This gem is in initial development, view the spec tests for examples of using the Shortee parser to parse a shortee message.

Contributing

  1. Fork it
  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 new Pull Request

Testing

To run all specs call rspec from the root directory. Spec files are located in the /spec directory.

rspec