= opensteam v0.9

* http://www.opensteam.net
* http://opensteam.rubyforge.org
* http://www.diamonddogs.cc



= AUTHOR:

Michael Schaerfer @ DiamondDogs Group



== DESCRIPTION:

An eCommerce Framework for RubyOnRails

== FEATURES

=== General Features

* Product Listing
* Details-Page for Products
* a Shopping-Cart (add, delete, increment/decrement quantity, checkout)
* a Checkout-Process
* an Admin-Backend to:
- create and configure Products
- create and configure Properties
- overview Order and Customer Information


=== Generators

openSteam offers three new generators (to use with script/generate):

* create a new webshop in no-time with
script/generate opensteam WebShopName
* create new products (like scaffold for models products)
script/generate opensteam_product ProductName [column:type]
* create new properties for products (like "color" for "Shirt") with
script/generate opensteam_property PropertyName [column:type]



=== Flexibility in Products

* create new Product-Models with a generator
* associate Products to Properties (a "Shirt" has_many "Colors")
* give the Product a price and a storage-quantity
* give specific configurations a price and a storage-quantity (a "blue-Shirt" is more expensive than a "yellow-Shirt")
* mark specific configurations as "Not-Active" or "Back-Ordered"


== SYNOPSIS:

Create an empty Rails Application
rails name_of_rails_application

Create the openSteam Framework
script/generate opensteam WebshopName

Create product models
script/generate opensteam_product ProductName [column:type]

Create property models
script/generate opensteam_property PropertyName [column:type]

Goto /administration and configure your products
usr: admin
pwd: admin



== REQUIREMENTS:

* rails (of course)



== INSTALL:

sudo gem install opensteam


== LICENSE:

Copyright 2008 DiamondDogs|Group

openSteam is distributed under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.