README.md in spree-2.0.13 vs README.md in spree-2.1.0
- old
+ new
@@ -1,5 +1,9 @@
+**THIS README IS FOR THE MASTER BRANCH OF SPREE AND REFLECTS THE WORK CURRENTLY
+EXISTING ON THE MASTER BRANCH. IF YOU ARE WISHING TO USE A NON-MASTER BRANCH OF
+SPREE, PLEASE CONSULT THAT BRANCH'S README AND NOT THIS ONE.**
+
SUMMARY
-------
Spree is a complete open source e-commerce solution built with Ruby on Rails. It
@@ -19,26 +23,30 @@
* spree_core (Models & Mailers, the basic components of Spree that it can't run without)
* spree_sample (Sample data)
All of the gems are designed to work together to provide a fully functional
e-commerce platform. It is also possible, however, to use only the pieces you are
-interested in. So for example, you could use just the barebones spree\_core gem
-and perhaps combine it with your own custom promotion scheme instead of using
-spree_promo.
+interested in. For example, you could use just the barebones spree\_core gem
+and perhaps combine it with your own custom backend admin instead of using
+spree_api.
[![Code Climate](https://codeclimate.com/github/spree/spree.png)](https://codeclimate.com/github/spree/spree)
Installation
------------
+**THIS README IS FOR THE MASTER BRANCH OF SPREE AND REFLECTS THE WORK CURRENTLY
+EXISTING ON THE MASTER BRANCH. IF YOU ARE WISHING TO USE A NON-MASTER BRANCH OF
+SPREE, PLEASE CONSULT THAT BRANCH'S README AND NOT THIS ONE.**
+
The fastest way to get started is by using the spree command line tool
available in the spree gem which will add Spree to an existing Rails application.
```shell
-gem install rails -v 3.2.21
+gem install rails -v 4.0.0
gem install spree
-rails _3.2.21_ new my_store
+rails _4.0.0_ new my_store
spree install my_store
```
This will add the Spree gem to your Gemfile, create initializers, copy migrations
and optionally generate sample products and orders.
@@ -181,17 +189,17 @@
```
Performance
-----------
-You may noticed that your Spree store runs slowly in development mode. This is
-a side-effect of how Rails works in development mode which is to continuous reload
+You may notice that your Spree store runs slowly in development mode. This is
+a side-effect of how Rails works in development mode which is to continuously reload
your Ruby objects on each request. The introduction of the asset pipeline in
Rails 3.1 made default performance in development mode significantly worse. There
are, however, a few tricks to speeding up performance in development mode.
-You can recompile your assets as follows:
+You can precompile your assets as follows:
```shell
bundle exec rake assets:precompile:nondigest
```
@@ -256,10 +264,16 @@
cd core
bundle exec rake test_app
bundle exec rspec spec
```
+If you would like to run specs against a particular database you may specify the
+dummy apps database, which defaults to sqlite3.
+```shell
+DB=postgres bundle exec rake test_app
+```
+
If you want to run specs for only a single spec file
```shell
bundle exec rspec spec/models/state_spec.rb
```
@@ -282,9 +296,13 @@
to run this command at the root of the Spree project to
generate test applications and run specs for all the facets:
```shell
bash build.sh
```
+
+Further Documentation
+------------
+Spree has a number of really useful guides online at [http://guides.spreecommerce.com](http://guides.spreecommerce.com).
Contributing
------------
Spree is an open source project and we encourage contributions. Please see the