From dbcf4d1573699c84f2eaa0e9e010a88cc9fa5c79 Mon Sep 17 00:00:00 2001 From: Ben Koshy Date: Mon, 12 Aug 2019 11:54:33 +1000 Subject: [PATCH] Update README.markdown ### 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](https://github.com/vmg/rinku/issues/81) Hopefully that will simplify things! --- README.markdown | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.markdown b/README.markdown index 3d88ae2..665b2d3 100644 --- a/README.markdown +++ b/README.markdown @@ -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 ---------- ```