From eaa34e86d818020b922a08f6327450cbbe0e8779 Mon Sep 17 00:00:00 2001 From: Captain Future Date: Mon, 18 Apr 2011 22:09:17 +0200 Subject: [PATCH] minor readme fix --- README.textile | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.textile b/README.textile index 13b004d..51e8e67 100644 --- a/README.textile +++ b/README.textile @@ -1,11 +1,9 @@ -h2. Spree Digital +h1. Spree Digital This is a spree extension to enable downloadable products. The design goal is to keep it robust. It should survive future spree versions out of the box. NOTE: This is still under development, but since things were falling into place, I thought I'd publish it. -h3. Introduction - The idea is simple. You attach a file to a Product (or a Variant of this Product) and when people buy it, they will receive a link via email where they can download it once. There are a few assumptions that spree_digital (currently) makes and it's important to be aware of them. These might change, but since I programmed digital_spree over night, this is what you get ;) * The table structure of spree_core is not touched. Spree_digital lives parallel to spree_core and does not do any changes to your existing database, except adding two new tables. @@ -17,9 +15,9 @@ The idea is simple. You attach a file to a Product (or a Variant of this Product * The file @views/order_mailer/confirm_email.text.erb@ is the only thing that should need customization. But since I assume you do that anyway, it doesn't hurt to do it when you're using spree_digital. The reason is that the download links are added to the confirmation email to the customer. * A purchased product can be downloaded even if you disable the product immediately. You would have to remove the attached file in your admin section to prevent people from downloading purchased products. -h3. Installation +h2. Installation -I assume that you already have a Rails 3 Spree application up and running. If you don't, the "Spree Documentation":http://spreecommerce.com/documentation will help you getting started. +I assume that you already have a Rails 3 Spree application up and running. If not, the "Spree Documentation":http://spreecommerce.com/documentation will help you getting started. To make use of @digital_spree@, you need to add this line to your @Gemfile@: @@ -27,20 +25,20 @@ To make use of @digital_spree@, you need to add this line to your @Gemfile@: gem 'spree_social', :git => 'git://github.com/funkensturm/spree_digital.git', :branch => 'master' -The following terminal commands will copy the file "spree_digital/db/migration/20110410134726_create_digitals.rb"http://github.com/funkensturm/spree_digital/blob/master/db/migrate/20110410134726_create_digitals.rb to the corresponding directory in your Rails application and apply the migration to your database. +The following terminal commands will copy the file "spree_digital/db/migration/20110410134726_create_digitals.rb":http://github.com/funkensturm/spree_digital/blob/master/db/migrate/20110410134726_create_digitals.rb to the corresponding directory in your Rails application and apply the migration to your database. 
-  rake spree_digital:install   # This one will copy the migration file from spree_digital to your rails_root/db/migrate
+  rake spree_digital:install
   rake db:migrate
This should be all there is to do. -h4. Important Notice +h3. Important! You should go to the spree admin section and create a shipping method that has the word @download@ somehow in its name (it should be cost-free, but it doesn't have to). It will be detected by spree_digital. Otherwise your customer will be forced to choose something like "UPS" even if they purchase only downloadable products. -h3. Usage +h2. Usage ...