Insynia/timeline-rails

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![Build Status](https://travis-ci.org/Insynia/timeline_rails.svg?branch=master)](https://travis-ci.org/Insynia/timeline_rails)
[![Coverage Status](https://coveralls.io/repos/github/Insynia/timeline_rails/badge.svg?branch=master)](https://coveralls.io/github/Insynia/timeline_rails?branch=master)
[![Code Climate](https://codeclimate.com/github/Insynia/timeline-rails/badges/gpa.svg)](https://codeclimate.com/github/Insynia/timeline-rails)
[![Dependency Status](https://gemnasium.com/badges/github.com/Insynia/timeline-rails.svg)](https://gemnasium.com/github.com/Insynia/timeline-rails)
[![security](https://hakiri.io/github/Insynia/timeline-rails/master.svg)](https://hakiri.io/github/Insynia/timeline-rails/master)

# Timeline::Rails

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/timeline/rails`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'timeline-rails'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install timeline-rails

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/timeline-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).