README.md in wherex-1.0.8 vs README.md in wherex-1.1.0
- old
+ new
@@ -1,17 +1,21 @@
-# wherex [](https://travis-ci.org/smathy/wherex)
+# wherex
+[](https://travis-ci.org/smathy/wherex) [](https://codeclimate.com/github/smathy/wherex) [](https://codeclimate.com/github/smathy/wherex)
+
Regexp support to ActiveRecord finders.
-## Howto?
+## Installation
-In your Gemfile
+Wherex is [Semantically Versioned](http://semver.org/), meaning that we will
+always indicate a backwardly incompatible change with a MAJOR version bump, so
+you can just use this in your `Gemfile`:
- gem 'wherex'
+```ruby
+gem 'wherex', '~> 1.0'
+```
-Then run `bundle install`
-
## What the?
# find users in 93, 94 and 95 (5 digit) zipcodes (new style finder)
User.where :zipcode => /^9[345][0-9]{3}$/
@@ -85,16 +89,16 @@
default is SQLite and requires no preconfiguration. So you can just clone the
repo and run `rake` and it will run the tests against SQLite
If you want to run the tests against MySQL or PostgreSQL then you will first
need to create a `wherex_test` database in your local machine. Then you will
-need to provide the `RAILS_DB` environment variable to rake, eg:
+need to provide the `DB` environment variable to rake, eg:
- RAILS_DB=mysql rake
+ DB=mysql rake
…or…
- RAILS_DB=postgres rake
+ DB=postgres rake
These will use a default user of `root` for MySQL and `postgres` for PostgreSQL.
If you want to use different usernames or passwords then take a look in the
`config/database.yml` file and either provide the appropriate environment
variables, or edit the file itself.