README.md in ruby-short_url-1.1.0 vs README.md in ruby-short_url-1.2.0
- old
+ new
@@ -1,19 +1,23 @@
# 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)
## 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.
+>
+> The URL alphabet is fully customizable and may contain any number of characters.
+> The intended use is that incrementing, consecutive integers will be used as keys to generate the short URLs. For example, when creating a new URL, the unique integer ID assigned by a database could be used to generate the URL by using this module. Or a simple counter may be used. As long as the same integer is not used twice, the same short URL will not be generated twice.
+
More detail is [here](https://github.com/Alir3z4/python-short_url#short-url-generator).
## Installation
Add this line to your application's `Gemfile`:
@@ -38,11 +42,11 @@
# decode encoded
Ruby::ShortUrl::Encoder.new.decode_url("00crI") # => 123456
```
-### Create your own short URL
+### Create your own URL Shortner
```rb
class CustomEncoder < Ruby::ShortUrl::Encoder
def initialize
# Set your own custom alphabet and block_size
@@ -59,16 +63,20 @@
# => "00022"
# > custom_encoder.encode_url(2)
# => "00011"
# > custom_encoder.encode_url(3)
# => "00033"
+# > custom_encoder.encode_url(4)
+# => "0000a"
#
# > custom_encoder.decode_url("00022")
# => 1
# > custom_encoder.decode_url("00011")
# => 2
# > custom_encoder.decode_url("00033")
# => 3
+# > custom_encoder.decode_url("0000a")
+# => 4
```
## 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.