Skip to content

Commit

Permalink
Update README.markdown
Browse files Browse the repository at this point in the history
### What is this PR?

Added rails installation instructions.

### Why this PR?

This PR attempts to solve this problem: of fast installation for newbies. I was wondering: where to add the `require 'rinku'` statement? It seems that I wasn't the only person facing this problem. Please refer to [this issue](vmg#81) 

Hopefully that will simplify things!
  • Loading branch information
benkoshy authored Aug 12, 2019
1 parent 0e0a80b commit dbcf4d1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,14 @@ end
The `rails_rinku` package monkeypatches Rails with an `auto_link` method that
mimics 100% the original one, parameter per parameter. It's just faster.

Rails Installation
----------------------------------------------------

* Add: `gem 'rinku', :require => 'rails_rinku'` to your `Gemfile.rb`
* Run `bundle install`.
* Now you should have the `auto_link` method available in your views!


Developing
----------
```
Expand Down

0 comments on commit dbcf4d1

Please sign in to comment.