README.md in odbc_adapter-5.0.0 vs README.md in odbc_adapter-5.0.1
- old
+ new
@@ -1,13 +1,19 @@
# ODBCAdapter
[](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 will work for basic queries for most DBMSs out of the box, without support for migrations. Full support is built-in for MySQL 5 and PostgreSQL 9 databases. You can register your own adapter to get more support for your DBMS using the `ODBCAdapter.register` function.
+
+A lot of this work is based on [OpenLink's ActiveRecord adapter](http://odbc-rails.rubyforge.org/) which works for earlier versions of Rails.
+
## 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
gem 'odbc_adapter'
```
@@ -20,14 +26,30 @@
$ gem install odbc_adapter
## Usage
-## Development
+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:
-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.
+```
+development:
+ adapter: odbc
+ dsn: MyDatabaseDSN
+```
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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.
+
+## Testing
+
+To run the tests, you'll need the ODBC driver as well as the connection adapter for each database against which you're trying to test. Then run `DSN=MyDatabaseDSN bundle exec rake test` and the test suite will be run by connecting to your database.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/localytics/odbc_adapter.