README.md in spree_retailers-0.70.0.0 vs README.md in spree_retailers-1.0.0.0
- old
+ new
@@ -1,51 +1,91 @@
-Spree Retailers
-===============
+# Spree Retailers [](http://travis-ci.org/citrus/spree_retailers)
Spree Retailers is a Spree extension for listing your company's retail stores on your web site.
+------------------------------------------------------------------------------
Installation
-------------
+------------------------------------------------------------------------------
As usual, add 'spree_retailers' to your Gemfile and run bundle install:
-
- # Spree 0.70.x
- gem 'spree_retailers', '0.70.0.0'
-
- # Spree 0.50.x, 0.60.x
- gem 'spree_retailers', '0.50.0.0'
-
- # Spree 0.40.x
- gem 'spree_retailers', '0.40.0.4'
-
- # install from git
- gem 'spree_retailers', :git => 'git://github.com/citrus/spree_retailers.git'
+
+```ruby
+# Spree 1.0.x
+gem 'spree_retailers', '1.0.0.0'
+# Spree 0.70.x
+gem 'spree_retailers', '0.70.0.0'
+# Spree 0.50.x, 0.60.x
+gem 'spree_retailers', '0.50.0.0'
+
+# Spree 0.40.x
+gem 'spree_retailers', '0.40.0.4'
+
+# install from source
+gem 'spree_retailers', :git => 'git://github.com/citrus/spree_retailers.git'
+```
+
+
Next, copy the migration file to your project:
- # Spree 0.40.x, 0.50.x and 0.60.x
- rake spree_retailers:install
-
- # 0.70.x and above
- rails g spree_retailers:install
+```bash
+# Spree 0.40.x, 0.50.x and 0.60.x
+rake spree_retailers:install
+# 0.70.x and above
+rails g spree_retailers:install
+```
+
Now, migrate your database with:
- rake db:migrate
+```bash
+rake db:migrate
+```
+------------------------------------------------------------------------------
+Testing
+------------------------------------------------------------------------------
+If you'd like to run tests:
+
+```bash
+git clone git://github.com/citrus/spree_retailers.git
+cd spree_retailers
+bundle install
+bundle exec dummier
+bundle exec rake
+```
+
+
+------------------------------------------------------------------------------
+Demo
+------------------------------------------------------------------------------
+
+If you'd like a demo of spree_retailers:
+
+```bash
+git clone git://github.com/citrus/spree_retailers.git
+cd spree_retailers
+cp test/dummy_hooks/after_migrate.rb.sample test/dummy_hooks/after_migrate.rb
+bundle install
+bundle exec dummier
+cd test/dummy
+rails s
+```
+
+
+------------------------------------------------------------------------------
To Do
------
+------------------------------------------------------------------------------
-* Write controller tests
-* Write admin tests
* Google map integration (we're already geocoding, so why not?)
* Add (better) International Support
+------------------------------------------------------------------------------
License
--------
+------------------------------------------------------------------------------
-Copyright (c) 2011 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.
+Copyright (c) 2011 - 2012 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.