README.rdoc in hydroponics-0.2.2 vs README.rdoc in hydroponics-0.3.0

- old
+ new

@@ -1,17 +1,36 @@ = Hydroponics -A user interface to seed or destroy large quantities of data in a Rails app. +A user interface to seed or destroy large quantities of data in a Rails app as quickly as possible. -== Note on Patches/Pull Requests +This project began after I tried to create 25,000 users in our Rails app, Pipeline, using a ruby script I wrote one day. It took many, many hours to run the script. So then I thought of how much faster it would be if I was just writing plain SQL. But then I remembered how much of a pain it is to write SQL. I read up on Sequel, tried it out, and discovered that it was pleasant to use and very quick. + +I came up with the name Hydroponics trying to tie together "Pipeline" and the concept of "seeding" a database. I don't know if pipelines can have hydroponics in them, but I like the name anyway. + +== Installation + +From the shell: -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. + gem install hydroponics + hydro -ovr <RAILS_ROOT> + +where <RAILS_ROOT> is the folder containing your Rails project. + +== Usage + +Go to the url: + + http://localhost:9294/dupe/<table> + +where <table> is the table name you want to seed. You must already have at least one row in the table for Dupe to work. + +== Extension + +Right now, the Hydroponics UI is a Sinatra app, but it is laid out like a Rails project. Put your new routes in config/hydro_app.rb and your new database actions in app/actions/. + +== Acknowledgement + +All thanks and praise are due to Allah. == Copyright Copyright (c) 2010 Tyler Boyd. See LICENSE for details.