README.md in acts_as_hashids-0.1.4 vs README.md in acts_as_hashids-0.1.5

- old
+ new

@@ -1,13 +1,14 @@ # acts_as_hashids [![Gem Version][gem-image]][gem-link] +[![Download][download-image]][download-link] [![Build Status][build-image]][build-link] [![Coverage Status][cov-image]][cov-link] [![Code Climate][gpa-image]][gpa-link] -Use [Hashids](https://github.com/peterhellberg/hashids.rb) (a.k.a. Youtube-Like ID) in ActiveRecord effectively. +Use [Hashids](https://github.com/peterhellberg/hashids.rb) (a.k.a. Youtube-Like ID) in ActiveRecord seamlessly. ## Installation Add the acts_as_hashids gem to your Gemfile. @@ -79,10 +80,23 @@ Foo2.create.to_param # => "RxQce3a2" ``` +### alphabet + +Specify which characters you use to generate hashids. + +```rb +class Foo < ActiveRecord::Base + acts_as_hashids alphabet: '0123456789uvwxyz' +end + +Foo3.create(id: 1).to_param +# => "4xw8zwyv" +``` + ## Test Execute the command below to run rspec and rubocop. ``` @@ -104,9 +118,11 @@ [gem-image]: https://badge.fury.io/rb/acts_as_hashids.svg [gem-link]: http://badge.fury.io/rb/acts_as_hashids +[download-image]:https://img.shields.io/gem/dt/acts_as_hashids.svg +[download-link]:https://rubygems.org/gems/acts_as_hashids [build-image]: https://secure.travis-ci.org/dtaniwaki/acts_as_hashids.png [build-link]: http://travis-ci.org/dtaniwaki/acts_as_hashids [cov-image]: https://coveralls.io/repos/dtaniwaki/acts_as_hashids/badge.png [cov-link]: https://coveralls.io/r/dtaniwaki/acts_as_hashids [gpa-image]: https://codeclimate.com/github/dtaniwaki/acts_as_hashids.png