README.md in slugr-1.0.0 vs README.md in slugr-1.1.0
- old
+ new
@@ -1,8 +1,8 @@
# Slugr
-Slugr is a gem to automatically create ActiveRecord object slugs for use in permalinks based on a title, name, headline, or some other unique and descriptive string field.
+Slugr is a gem to automatically create ActiveRecord object slugs for use in permalinks based on a title, name, headline, or some other unique and descriptive string field. It also provides a slug convenience method to the String class.
## Installation
Add this line to your application's Gemfile:
@@ -93,9 +93,18 @@
Slugr will do its best to normalize diacritics (accented characters) to its non accented ASCII equivalent:
```ruby
artist = Artist.create(name: "Mötley Crüe") # slug: "motley-crue"
+```
+
+### String extension
+
+Slugr extends the String class with a slug method.
+
+```ruby
+> "Côte d'Ivoire".slug
+ => "cote-divoire"
```
## 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.