Add require instructions to the readme

mfinelli · Oct 8, 2019 · 1aadc02 · 1aadc02
1 parent c0dd324
commit 1aadc02
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,18 @@ and authorization of users after that, `ruolo` is completely unopinionated.
 
 ## Usage
 
+### Require
+
+Include the gem in your gemfile:
+
+```ruby
+gem 'ruolo', require: false
+```
+
+Notice the `require: false` which is necessary so it doesn't automatically get
+included if you do something like `Bundler.require`. Make sure that you have a
+database connection and _then_ require the gem and configure it.
+
 ### Migrations
 
 You'll need to run the following database migration to setup your schema, fill