hardpixel/active-permalink

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# ActivePermalink

Add SEO friendly permalinks to ActiveRecord model with history support.

[![Gem Version](https://badge.fury.io/rb/active_permalink.svg)](https://badge.fury.io/rb/active_permalink)
[![Build Status](https://travis-ci.org/hardpixel/active-permalink.svg?branch=master)](https://travis-ci.org/hardpixel/active-permalink)
[![Maintainability](https://api.codeclimate.com/v1/badges/7669a285b9da35143c1f/maintainability)](https://codeclimate.com/github/hardpixel/active-permalink/maintainability)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'active_permalink'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install active_permalink

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/active-permalink.

## License

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