README.md in mysql_isolated_server-0.2.0 vs README.md in mysql_isolated_server-0.2.1
- old
+ new
@@ -1,29 +1,34 @@
-# MysqlIsolatedServer
+# Mysql Isolated Servers -- a gem for testing mysql stuff
-TODO: Write a gem description
+This gem provides functionality to quickly bring up and tear down mysql instances for the
+purposes of testing code against more advanced mysql topologies -- replication, vertical
+partitions, etc.
-## Installation
+I developed this as part of my testing strategy for implementing http://github.com/osheroff/ar_mysql_flexmaster, but it's
+been useful in developement of a couple of other projects too (http://github.com/osheroff/mmtop).
-Add this line to your application's Gemfile:
+## Usage
- gem 'mysql_isolated_server'
+```
+$mysql_master = MysqlIsolatedServer.new(allow_output: false)
+$mysql_master.boot!
-And then execute:
+puts "mysql master booted on port #{$mysql_master.port} -- access with mysql -uroot -h127.0.0.1 --port=#{$mysql_master.port} mysql"
- $ bundle
+$mysql_slave = MysqlIsolatedServer.new
+$mysql_slave.boot!
-Or install it yourself as:
+puts "mysql slave booted on port #{$mysql_slave.port} -- access with mysql -uroot -h127.0.0.1 --port=#{$mysql_slave.port} mysql"
- $ gem install mysql_isolated_server
+$mysql_slave_2 = MysqlIsolatedServer.new
+$mysql_slave_2.boot!
-## Usage
+puts "mysql chained slave booted on port #{$mysql_slave_2.port} -- access with mysql -uroot -h127.0.0.1 --port=#{$mysql_slave_2.port} mysql"
-TODO: Write usage instructions here
+$mysql_slave.make_slave_of($mysql_master)
+$mysql_slave_2.make_slave_of($mysql_slave)
-## Contributing
+$mysql_slave.set_rw(false)
+sleep if __FILE__ == $0
+```
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request