From 02b94ec036ed20e872dee4b9069a0617e7931f41 Mon Sep 17 00:00:00 2001 From: Nikita Bulai Date: Wed, 25 Mar 2020 00:34:55 +0300 Subject: [PATCH] [ci skip] Update README --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 70151b7..3bae67d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ [![Gem Version](https://badge.fury.io/rb/doorkeeper-mongodb.svg)](https://badge.fury.io/rb/doorkeeper-mongodb) [![Build Status](https://travis-ci.org/doorkeeper-gem/doorkeeper-mongodb.svg?branch=master)](https://travis-ci.org/doorkeeper-gem/doorkeeper-mongodb) +## Documentation + +This documentation is valid for `master` branch. Please check the documentation for the version +of doorkeeper-mongodb you are using in: https://github.com/doorkeeper-gem/doorkeeper-mongodb/releases. + ## Installation `doorkeeper-mongodb` provides [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) support to [Mongoid](https://github.com/mongodb/mongoid) @@ -9,17 +14,21 @@ to your Gemfile: ``` ruby -# For Doorkeeper < 4.4 -gem 'doorkeeper', '~> 4.3' -gem 'doorkeeper-mongodb', '~> 4.1.0' +# For Doorkeeper >= 5.2 +gem 'doorkeeper', '~> 5.2' +gem 'doorkeeper-mongodb', '~> 5.2' + +# For Doorkeeper >= 5.0 +gem 'doorkeeper', '~> 5.0' +gem 'doorkeeper-mongodb', '~> 5.0' # For Doorkeeper >= 4.4 && < 5.0 gem 'doorkeeper', '~> 4.4' gem 'doorkeeper-mongodb', '~> 4.2' -# For Doorkeeper >= 5.0 -gem 'doorkeeper', '~> 5.0' -gem 'doorkeeper-mongodb', '~> 5.0' +# For Doorkeeper < 4.4 +gem 'doorkeeper', '~> 4.3' +gem 'doorkeeper-mongodb', '~> 4.1.0' # or if you want to use cutting edge version: # gem 'doorkeeper-mongodb', github: 'doorkeeper-gem/doorkeeper-mongodb'