README.md in spree-2.3.13 vs README.md in spree-2.4.0.rc1
- old
+ new
@@ -1,9 +1,12 @@
+**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
was originally developed by Sean Schofield and is now maintained by a dedicated
[core team](https://github.com/spree/spree/wiki/Core-Team). You can find out more by
visiting the [Spree e-commerce project page](http://spreecommerce.com).
@@ -38,13 +41,13 @@
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 4.1.11
+gem install rails -v 4.1.6
gem install spree
-rails _4.1.11_ new my_store
+rails _4.1.6_ 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.
@@ -61,19 +64,26 @@
```shell
spree install my_store -A
```
+To select a specific branch, pass in the `--branch` option. If there is no branch, you
+will be given the latest version of either spree_auth_devise or spree_gateway.
+
+```shell
+spree install my_store --branch "2-4-stable"
+```
+
Using stable builds and bleeding edge
-------------
To use a stable build of Spree, you can manually add Spree to your
-Rails 4.1.x application. To use the 2-3-stable branch of Spree, add this line to
+Rails application. To use the 2-4-stable branch of Spree, add this line to
your Gemfile.
```ruby
-gem 'spree', github: 'spree/spree', branch: '2-3-stable'
+gem 'spree', github: 'spree/spree', branch: '2-4-stable'
```
Alternatively, if you want to use the bleeding edge version of Spree, use this
line:
@@ -87,11 +97,11 @@
If you wish to have authentication included also, you will need to add the
`spree_auth_devise` gem as well. Either this:
```ruby
-gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '2-3-stable'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '2-4-stable'
```
Or this:
```ruby
@@ -147,10 +157,12 @@
Browse Admin Interface
----------------------
http://localhost:nnnn/admin
+
+
Working with the edge source (latest and greatest features)
-----------------------------------------------------------
The source code is essentially a collection of gems. Spree is meant to be run
within the context of Rails application. You can easily create a sandbox
@@ -268,16 +280,16 @@
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
+bundle exec rspec spec/models/spree/state_spec.rb
```
If you want to run a particular line of spec
```shell
-bundle exec rspec spec/models/state_spec.rb:7
+bundle exec rspec spec/models/spree/state_spec.rb:7
```
You can also enable fail fast in order to stop tests at the first failure
```shell
FAIL_FAST=true bundle exec rspec spec/models/state_spec.rb
@@ -310,11 +322,15 @@
Further Documentation
------------
Spree has a number of really useful guides online at [http://guides.spreecommerce.com](http://guides.spreecommerce.com).
+Roadmap
+------------
+Spree roadmap at [https://trello.com/b/PQsUfCL0/spree-roadmap](https://trello.com/b/PQsUfCL0/spree-roadmap).
+
Contributing
------------
Spree is an open source project and we encourage contributions. Please see the
-[contributors guidelines](http://guides.spreecommerce.com/developer/contributing.html)
+[contributors guidelines](http://spreecommerce.com/documentation/contributing_to_spree.html)
before contributing.