README.md in superstore-2.3.0 vs README.md in superstore-2.4.0

- old
+ new

@@ -1,17 +1,35 @@ # Superstore -[![Build Status](https://secure.travis-ci.org/data-axle/superstore.png?rvm=2.0.0)](http://travis-ci.org/data-axle/superstore) [![Code Climate](https://codeclimate.com/github/data-axle/superstore/badges/gpa.svg)](https://codeclimate.com/github/data-axle/superstore) +[![Build Status](https://secure.travis-ci.org/data-axle/superstore.png?rvm=2.0.0)](http://travis-ci.org/data-axle/superstore) +[![Code Climate](https://codeclimate.com/github/data-axle/superstore/badges/gpa.svg)](https://codeclimate.com/github/data-axle/superstore) +[![Gem](https://img.shields.io/gem/v/superstore.svg?maxAge=2592000)](https://rubygems.org/gems/superstore) -Superstore uses ActiveModel to mimic much of the behavior in ActiveRecord. +Superstore is a PostgreSQL JSONB document store which uses ActiveModel to mimic much of the behavior +in ActiveRecord. +## Requirements + +Superstore requires PostgreSQL 9.5 or above. + ## Installation Add the following to the `Gemfile`: + ```ruby +gem 'pg' gem 'superstore' ``` +Add a `config/superstore.yml`: + +```yaml +development: + adapter: jsonb +``` + +Superstore will share the existing ActiveRecord database connection. + ## Defining Models ```ruby class Widget < Superstore::Base string :name @@ -33,26 +51,9 @@ ```ruby class MyWidget < Superstore::Base table_name = 'my_widgets' end ``` - -## Using the PostgreSQL JSONB adapter - -Add the `pg` gem to the `Gemfile`: - -```ruby -gem 'pg' -``` - -Add a `config/superstore.yml`: - -```yaml -development: - adapter: jsonb -``` - -Superstore will share the existing ActiveRecord database connection. ## Creating and updating records Superstore has equivalent methods to ActiveRecord: