Usage documentation

README.md

@@ -2,10 +2,14 @@
 
 [![Build Status](https://travis-ci.com/localytics/odbc_adapter.svg?token=kQUiABmGkzyHdJdMnCnv&branch=master)](https://travis-ci.com/localytics/odbc_adapter)
 
-An ActiveRecord ODBC adapter.
+An ActiveRecord ODBC adapter. Master branch is working off of edge Rails. Previous work has been done to make it compatible with Rails 3.2 and 4.2; for those versions use the 3.2.x or 4.2.x gem releases.
+
+This adapter currently works for connecting using ODBC to MySQL 5 and PostgreSQL 9 databases. You can also register your own adapter using the `ODBCAdapter.register` function to connect to a database of your choice.
 
 ## Installation
 
+Ensure you have the ODBC driver installed on your machine. You will also need the driver for whichever database to which you want ODBC to connect.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -22,6 +26,24 @@ Or install it yourself as:
 
 ## Usage
 
+Configure your `database.yml` by either using the `dsn` option to point to a DSN that corresponds to a valid entry in your `~/.odbc.ini` file:
+
+```
+development:
+  adapter:  odbc
+  dsn: MyDatabaseDSN
+```
+
+or by using the `conn_str` option and specifying the entire connection string:
+
+```
+development:
+  adapter: odbc
+  conn_str: "DRIVER={PostgreSQL ANSI};SERVER=localhost;PORT=5432;DATABASE=my_database;UID=postgres;"
+```
+
+ActiveRecord models that use this connection will now be connecting to the configured database using the ODBC driver.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.