Browse files

updated readme for 0.2.0 release

  • Loading branch information...
1 parent d080835 commit b53e3f28797f0517eac975814c9b506fda803427 @mwlang committed May 4, 2010
Showing with 30 additions and 23 deletions.
  1. +30 −23 README.md
View
53 README.md
@@ -1,9 +1,8 @@
# sequel_plus
-This library starts the collection of plugins and extensions I have assembled for the Ruby Sequel library.
-The library is in very early infancy stage, so there's not much presently, but what's here is fully covered
-in specs and tested and used in production-level deployments already.
-
+This library contains a growing collection of plugins and extensions I have assembled for the Ruby Sequel library.
+The library is in its infancy stage with new things being added and updated semi-frequently. Even so,
+what's here is fully covered in specs and tested and used in production-level deployments already.
### Currently, sequel_plus contains:
* plugin for Trees to mimic the Rails acts_as_tree plugin.
@@ -49,10 +48,10 @@ This gem is released to gemcutter. Rubyforge is not utilized.
## Use Rake Tasks
-Several rake tasks are made available simply by including the "tasks/sequel" per below:
+Several rake tasks are made available simply by requiring "tasks/sequel" in your Rakefile
+(or loaded rake scripts) per below:
require 'sequel'
- require 'sequel_plus'
require 'tasks/sequel'
task :environment do
@@ -68,26 +67,34 @@ Several rake tasks are made available simply by including the "tasks/sequel" per
Example tasks that are available:
-* rake db:desc[table] # Displays schema of table
-* rake db:fields[table] # Displays simple list of fields of table in sorted order
-* rake db:migrate # Migrate the database through scripts in db/migrate and update db/schema.rb by in...
-* rake db:migrate:down[step] # Reverts to previous schema version.
-* rake db:migrate:new[table,verb] # Creates a new migrate script.
-* rake db:migrate:redo # Rollbacks the database one migration and re-migrates up.
-* rake db:migrate:up[version] # Runs the "up" for a given migration VERSION.
-* rake db:reset # Drops all tables and recreates the schema from db/schema.rb
-* rake db:rollback # Rolls the schema back to the previous version.
-* rake db:schema:drop # drops the schema, using schema.rb
-* rake db:schema:dump # Dumps the schema to db/schema.db
-* rake db:schema:load # loads the schema from db/schema.rb
-* rake db:schema:version # Returns current schema version
-* rake db:show[table] # Displays content of table or lists all tables
-* rake db:tables # Displays a list of tables in the database
-
-These tasks will expect migrations to be in db/migration that is based off the folder your Rakefile resides in. If you wish to change the location of the "db" folder, simply declare :environment task and set APP_ROOT folder to be something other than the folder the Rakefile is residing in.
+* rake sq:desc[table] # Displays schema of table
+* rake sq:fields[table] # Displays simple list of fields of table in sorted order
+* rake sq:migrate # Migrate the database through scripts in db/migrate and update db/schema.rb by in...
+* rake sq:migrate:down[step] # Reverts to previous schema version.
+* rake sq:migrate:new[table,verb] # Creates a new migrate script.
+* rake sq:migrate:redo # Rollbacks the database one migration and re-migrates up.
+* rake sq:migrate:up[version] # Runs the "up" for a given migration VERSION.
+* rake sq:reset # Drops all tables and recreates the schema from db/schema.rb
+* rake sq:rollback # Rolls the schema back to the previous version.
+* rake sq:schema:drop # drops the schema, using schema.rb
+* rake sq:schema:dump # Dumps the schema to db/schema.db
+* rake sq:schema:load # loads the schema from db/schema.rb
+* rake sq:schema:version # Returns current schema version
+* rake sq:show[table] # Displays content of table or lists all tables
+* rake sq:tables # Displays a list of tables in the database
+
+These tasks will expect migrations to be in db/migration that is based off the folder your Rakefile resides in. If you wish to change the location of the "db" folder, simply declare :environment task and set SEQUEL_PLUS_APP_ROOT constant to be something other than the folder the Rakefile is residing in.
+
+The rake tasks were constructed to fairly independent of the project environment they're injected into. To avoid name space collision,
+the "db" namespace has been deprecated and the "sq" namespace adopted as of 0.2.0.
# Note on Patches/Pull Requests
+0.2.0
+* top-level namespace changed from "db" to "sq"
+* designed and tested to work seamlessly with Padrino and Ramaze projects
+
+0.1.5
* This release adds rake tasks
* last release adds an export facility to the Sequel::Dataset

0 comments on commit b53e3f2

Please sign in to comment.