README.md in omniauth-identity-3.0.8 vs README.md in omniauth-identity-3.0.9

- old
+ new

@@ -19,11 +19,20 @@ This gem is compatible with, as of Feb 2021, version 3: * Latest released version of omniauth, v2.0.2 * Ruby 2.4, 2.5, 2.6, 2.7, 3.0, ruby-head +* At least 5 different database ORM adapters, which connect to 15 different database clients! +| Databases | Adapter Libraries | +|--------- | -------- | +| MySQL, PostgreSQL, SQLite3 | [ActiveRecord](https://guides.rubyonrails.org/active_record_basics.html) | +| CouchDB | [CouchPotato](https://github.com/langalex/couch_potato) | +| MongoDB | [Mongoid](https://github.com/mongodb/mongoid) | +| RethinkDB | [NoBrainer](http://nobrainer.io/) | +| ADO, Amalgalite, IBM_DB, JDBC, MySQL, Mysql2, ODBC, Oracle, PostgreSQL, SQLAnywhere, SQLite3, and TinyTDS | [Sequel](http://sequel.jeremyevans.net) | + ## Installation To acquire the latest release from RubyGems add the following to your `Gemfile`: ```ruby @@ -169,11 +178,11 @@ provider :identity, fields: [:email], model: MyCustomClass end ``` NOTE: In the above example, `MyCustomClass` must have a class method called `auth_key` that returns - the default (`email`) or custom `auth_key` to use. +the default (`email`) or custom `auth_key` to use. ## Customizing Registration Failure To use your own custom registration form, create a form that POSTs to `/auth/identity/register` with `password`, `password_confirmation`, and your @@ -271,43 +280,44 @@ 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am ‘Added some feature’`) 4. Push to the branch (`git push origin my-new-feature`) 5. Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally. - - NOTE: In order to run *all* the tests you will need to have the following databases installed, configured, and running. - 1. [RethinkDB](https://rethinkdb.com), an open source, real-time, web database, [installed](https://rethinkdb.com/docs/install/) and [running](https://rethinkdb.com/docs/start-a-server/), e.g. - ```bash - brew install rethinkdb - rethinkdb - ``` - 2. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/) - ```bash - brew tap mongodb/brew - brew install mongodb-community@4.4 - mongod --config /usr/local/etc/mongod.conf - ``` - 3. [CouchDB](https://couchdb.apache.org) (download the .app) - To run all tests on all databases: - ```bash - bundle exec rake - ``` - To run a specific DB: - ```bash - # CouchDB / CouchPotato - bundle exec rspec spec spec_orms --tag 'couchdb' + - NOTE: In order to run *all* the tests you will need to have the following databases installed, configured, and running. + 1. [RethinkDB](https://rethinkdb.com), an open source, real-time, web database, [installed](https://rethinkdb.com/docs/install/) and [running](https://rethinkdb.com/docs/start-a-server/), e.g. + ```bash + brew install rethinkdb + rethinkdb + ``` + 2. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/) + ```bash + brew tap mongodb/brew + brew install mongodb-community@4.4 + mongod --config /usr/local/etc/mongod.conf + ``` + 3. [CouchDB](https://couchdb.apache.org) (download the .app) - # ActiveRecord and Sequel, as they both use the in-memory SQLite driver. - bundle exec rspec spec spec_orms --tag 'sqlite3' + To run all tests on all databases: + ```bash + bundle exec rake + ``` + To run a specific DB: + ```bash + # CouchDB / CouchPotato + bundle exec rspec spec spec_orms --tag 'couchdb' - # NOTE - mongoid and nobrainer specs can't be isolated with "tag" because it still loads everything, - # and the two libraries are fundamentally incompatible. + # ActiveRecord and Sequel, as they both use the in-memory SQLite driver. + bundle exec rspec spec spec_orms --tag 'sqlite3' - # MongoDB / Mongoid - bundle exec rspec spec_orms/mongoid_spec.rb + # NOTE - mongoid and nobrainer specs can't be isolated with "tag" because it still loads everything, + # and the two libraries are fundamentally incompatible. - # RethinkDB / NoBrainer - bundle exec rspec spec_orms/nobrainer_spec.rb - ``` + # MongoDB / Mongoid + bundle exec rspec spec_orms/mongoid_spec.rb + + # RethinkDB / NoBrainer + bundle exec rspec spec_orms/nobrainer_spec.rb + ``` 6. Create new Pull Request ## License MIT License. See LICENSE for details.