Merge pull request #39 from vinsol/3-1-readme

Update readme for 3-1-stable

README.md

@@ -1,14 +1,21 @@
 SpreeItemsSubscriptions
+=============
 
-Introduction goes here.
+SpreeItemsSubscriptions is an extension to let users have time interval based subscription of products in a spree application.
+
+* This extension allows the admin to create a subscribable product on the Admin end.
+
+* This product can then be bought one-time or as a subscription.
+
+* Once subscribed, subscription orders will automatically be created for the user at the selected time interval.
 
 Installation
 ------------
 
 Add spree_items_subscriptions to your Gemfile:
 
 ```ruby
-gem 'spree_items_subscriptions'
+gem 'spree_items_subscriptions', github: 'vinsol/spree_items_subscriptions', branch: '3-1-stable'
 ```
 
 Bundle your dependencies and run the installation generator:
@@ -18,14 +25,45 @@ bundle
 bundle exec rails g spree_items_subscriptions:install
 ```
 
+You can also seed the default data with:
+```shell
+bundle exec rails g spree_items_subscriptions:seed
+```
+
+Working
+-------
+
+* Admin can mark a product as "subscribable" on the `Admin -> Products -> Edit` page. The admin will have to choose the subscription frequencies to be made available for that product.
+
+* Subscription frequencies are created by default when you seed data. You can also add subscription frequencies through `Admin -> Configurations -> Subscription Frequencies -> New` page.
+
+* When user is purchasing a subscribable product, he gets an option to make it a 'One Time Order' or a 'Subscription Order'.
+
+* When making a 'Subscription Order', the user will have to choose Delivery Interval, Total Deliveries, and Quantity. The first order will be made on checkout and remaining orders will automatically be created for the user at the selected time intervals.
+
+* The users can check their subscriptions on the 'My Account' page. They can update subscription info, pause or cancel their subscriptions via the `Subscription -> Edit` page.
+
+* A cron job needs to be run to process subscriptions
+  ```
+  bundle exec rake subscription:process
+  ```
+  This will run the pending subscriptions.
+
+* A cron job can also be run to notify users of upcoming subscriptions:
+  ```
+  bundle exec rake subscription:prior_notify
+  ```
+  This will inform users that they have a subscription that is coming up in 'x' days. The number of days can be changed on subscription edit page.
+
 Testing
 -------
 
-First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
 
 ```shell
 bundle
-bundle exec rake
+bundle exec rake test_app
+bundle exec rspec spec
 ```
 
 When testing your applications integration with this extension you may use it's factories.
@@ -35,4 +73,9 @@ Simply add this require statement to your spec_helper:
 require 'spree_items_subscriptions/factories'
 ```
 
-Copyright (c) 2016 [name of extension creator], released under the New BSD License
+Credits
+-------
+
+[![vinsol.com: Ruby on Rails, iOS and Android developers](http://vinsol.com/themes/vinsoldotcom-theme/images/new_img/vin_logo.png "Ruby on Rails, iOS and Android developers")](http://vinsol.com)
+
+Copyright (c) 2016 [vinsol.com](http://vinsol.com "Ruby on Rails, iOS and Android developers"), released under the New MIT License