README.md in ruby-short_url-1.0.0 vs README.md in ruby-short_url-1.1.0
- old
+ new
@@ -1,15 +1,17 @@
# Ruby::ShortUrl
[](https://travis-ci.org/toshimaru/ruby-short_url)
+
[](http://badge.fury.io/rb/ruby-short_url)
[](https://codeclimate.com/github/toshimaru/ruby-short_url/coverage)
[](https://codeclimate.com/github/toshimaru/ruby-short_url)
-[](https://gemnasium.com/toshimaru/ruby-short_url)
-Ruby implementation for generating Tiny URL. Ruby implementation of [python-short_url](https://github.com/Alir3z4/python-short_url)
+## Description
+Ruby implementation for generating Tiny URL. The implementation is based on [python-short_url](https://github.com/Alir3z4/python-short_url).
+
> A bit-shuffling approach is used to avoid generating consecutive, predictable URLs. However, the algorithm is deterministic and will guarantee that no collisions will occur.
More detail is [here](https://github.com/Alir3z4/python-short_url#short-url-generator).
## Installation
@@ -45,11 +47,13 @@
def initialize
# Set your own custom alphabet and block_size
super(alphabet: "0123abc", block_size: 5)
end
end
+```
+```rb
# > custom_encoder = CustomEncoder.new
# => #<CustomEncoder:0x007faf3babc830 @alphabet="0123abc", @block_size=5, @mask=31, @mapping=[0, 1, 2, 3, 4]>
#
# > custom_encoder.encode_url(1)
# => "00022"
@@ -66,16 +70,16 @@
# => 3
```
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/ruby-short_url/fork )
-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 a new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/toshimaru/ruby-short_url. 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](https://opensource.org/licenses/MIT).