README.md in scenic_mysql-0.1.2 vs README.md in scenic_mysql-0.1.3
- old
+ new
@@ -1,16 +1,15 @@
-# ScenicMysql
+# Scenic Mysql Adapter
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/scenic_mysql`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem adds MySQL support for the wonderful [Scenic](https://github.com/thoughtbot/scenic) gem by Thoughtbot.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
+gem 'scenic'
gem 'scenic_mysql'
```
And then execute:
@@ -20,22 +19,33 @@
$ gem install scenic_mysql
## Usage
-TODO: Write usage instructions here
+Add an initializer with the following code:
-## Development
+```ruby
+# This code overwrites Mysql2Adapter's `database` method,
+# which pulls back all tables with views.
+#
+# The new method returns only tables, without the views.
+#
+ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(
+ :include, Scenic::Adapters::Mysql::TablesDefinition
+)
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Tell Scenic to use MySQL instead of the defaulted PostgreSQL.
+Scenic.configure do |config|
+ config.database = Scenic::Adapters::Mysql.new
+end
+```
-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).
+Note that the adapter currently does not support materialized views for MySQL.
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scenic_mysql.
+Bug reports and pull requests are welcome on GitHub at https://github.com/startweaving/scenic_mysql.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-