evan / shadow Goto Github PK

Shadow

A zero-configuration YAML RESTful ActiveRecord server.

== License

Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. 

The public certificate for the gem is here[http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem]. 

If you use this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails.

== Installation

  sudo gem install shadow

== Usage

Shadow requires a Rails-style <tt>database.yml</tt> configuration.

Start the server with:

  shadow [path_to/database.yml] [environment] [route]

Now you can query it at:

  http://0.0.0.0:2001/route/table_name/record_id
  
You need to make RESTful HTTP requests (GET, POST, PUT, or DELETE), with YAML form payloads for POST and PUT.

== Reporting problems

The support forum is here[http://rubyforge.org/forum/forum.php?forum_id=15381].

Patches and contributions are very welcome. Please note that contributors are required to assign copyright for their additions to Cloudburst, LLC.