= Comatose

Version:: 0.7.1
Author::  M@ McCray
Website:: www.mattmccray.com
Email::   darthapo at gmail dot com


*Comatose* is a micro CMS designed for being embedded into existing Rails 
applications.

It's intended for simple CMS support. Comatose supports 

 * Nested pages
 * Versioning
 * Page markup in Textile, Markdown, RDoc, or easily add your own 
 * Page processing through Liquid or ERb
 * Generators for easy installation/migration
 * Completely self-contained within plugin folder

It's meant to be lean, mean, easily embedded, and easy to re-skin for 
existing applications. If you need something more, I would recommend 
looking into Radiant.

For more information, see the 'Getting Started' guide: http://comatose.rubyforge.org


== Installation

*Note*: See the 'Upgrading' section if you already have an older version of 
        the comatose plugin installed.

  $ ./script/plugin source http://mattmccray.com/svn/rails/plugins
  $ ./script/plugin install comatose
  $ ./script/generate comatose_migration
  $ rake migrate

Open your <tt>routes.rb</tt> and add the comatose root route at the 
bottom:

  map.comatose_root ''

That's it, you're ready to go! You should be able to browse to 
http://127.0.0.1:3000/comatose_admin and start adding pages to your CMS. 
Browsing to http://127.0.0.1:3000/ will render your comatose pages if 
routing doesn't match any of your controllers. 


== Upgrading

If you are upgrading from an older version of Comatose (version 0.3, 
0.4, 0.5, or 0.6), then you will need to re-install the comatose 
plugin and run:

  $ ./script/plugin remove comatose
  $ ./script/plugin install comatose
  $ ./script/generate comatose_migration --upgrade --from=VERSION
  $ rake migrate

*Note*: Be sure to set the <tt>--from</tt> parameter to the version of
Comatose you last had installed. Also, you only need to first two digits,
including the dot, of the version you are upgrading from. For example, if
you're upgrading from version 0.6.9 you can use:

  $ ./script/generate comatose_migration --upgrade --from=0.6

This will create the upgrade migration(s) for you. It just adds the new 
fields, so you can keep the original migration comatose created.


== Extra Credit

This plugin includes the work of many wonderful contributors to the Railsphere. 
Following are the specific libraries that are distributed with Comatose. If I've 
missed someone/something please let me know.

 * Liquid (http://home.leetsoft.com/liquid) by Tobias Luetke (http://blog.leetsoft.com) 
 * RedCloth (http://whytheluckystiff.net/ruby/redcloth) by why the lucky stiff (http://whytheluckystiff.net)
 * Acts as Versioned (http://ar-versioned.rubyforge.org) by Rick Olsen (http://weblog.techno-weenie.net)


== Feedback

I’ve released Comatose under the MIT license. Which basically means you 
can use it however you want.

Don't forget to read the 'Getting Started' guide located on the RubyForge
project site: http://comatose.rubyforge.org/getting-started-guide

If you like it, hate it, or have some ideas for new features, let me know!

darthapo at gmail dot com