README.md in spree-3.1.14 vs README.md in spree-3.2.0.rc1
- old
+ new
@@ -1,26 +1,25 @@
-
+<img src="spree_logo.png" width="261">
-* [Join our Slack](http://slack.spreecommerce.com/)
-* [Documentation](http://guides.spreecommerce.com)
+* Join our Slack at [slack.spreecommerce.com](http://slack.spreecommerce.com/)
+* [Extensions](https://github.com/spree-contrib)
+* [Documentation](http://guides.spreecommerce.org)
+* Spree success stories from [OpenCommerce Conf](http://opencommerceconf.org/)
* [2016 Development Roadmap](https://github.com/spree/spree/wiki/Spree-Commerce-development-roadmap-2016)
-* [Vote & comment on roadmap features](https://trello.com/b/ta4WU3AX/spree-roadmap)
-[](https://circleci.com/gh/spree/spree)
+[](https://circleci.com/gh/spree/spree/tree/master)
[](https://codeclimate.com/github/spree/spree)
[](https://codebeat.co/projects/github-com-spree-spree)
[](http://slack.spreecommerce.com)
-[](http://issuestats.com/github/spree/spree)
-[](http://issuestats.com/github/spree/spree)
**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 developers from [Spark Solutions](http://sparksolutions.co) and [Vinsol](http://vinsol.com/). We're open to [contributions](#contributing) and accepting new [Core Team](https://github.com/spree/spree/wiki/Core-Team) members.
Spree consists of several different gems, each of which are maintained
in a single repository and documented in a single set of
-[online documentation](http://guides.spreecommerce.com/).
+[online documentation](http://guides.spreecommerce.org/).
* spree_api (RESTful API)
* spree_frontend (Customer frontend)
* spree_backend (Admin panel)
* spree_cmd (Command-line tools)
@@ -31,16 +30,26 @@
Getting Started
----------------------
Add Spree gems to your Gemfile:
+### Rails 5
+
```ruby
-gem 'spree', '~> 3.0.7'
-gem 'spree_auth_devise', '~> 3.0.5'
-gem 'spree_gateway', '~> 3.0.0'
+gem 'spree', '~> 3.2.0.rc1'
+gem 'spree_auth_devise', '~> 3.2.0.beta'
+gem 'spree_gateway', '~> 3.2.0.beta'
```
+### Rails 4.2
+
+```ruby
+gem 'spree', '~> 3.1.0'
+gem 'spree_auth_devise', '~> 3.1.0'
+gem 'spree_gateway', '~> 3.1.0'
+```
+
Run `bundle install`
Use the install generators to set up Spree:
```shell
@@ -88,15 +97,37 @@
Browse Admin Interface
----------------------
http://localhost:3000/admin
+Extensions
+----------------------
+Spree Extensions provide additional features not present in the Core system.
+
+| Extension | Description |
+| --- | --- |
+| [spree_i18n](https://github.com/spree-contrib/spree_i18n) | I18n translation files for Spree Commerce
+| [spree-multi-domain](https://github.com/spree-contrib/spree-multi-domain) | Multiple Spree stores on different domains - single unified backed for processing orders
+| [spree_multi_currency](https://github.com/spree-contrib/spree_multi_currency) | Provides UI to allow configuring multiple currencies in Spree |
+| [spree_braintree_vzero](https://github.com/spree-contrib/spree_braintree_vzero) | Official Spree Braintree v.zero + PayPal extension |
+| [spree_address_book](https://github.com/spree-contrib/spree_address_book) | Adds address book for users to Spree |
+| [spree_digital](https://github.com/spree-contrib/spree_digital) | A Spree extension to enable downloadable products |
+| [spree_social](https://github.com/spree-contrib/spree_social) | Building block for spree social networking features (provides authentication and account linkage) |
+| [spree_related_products](https://github.com/spree-contrib/spree_related_products) | Related products extension for Spree
+| [spree_active_shipping](https://github.com/spree-contrib/spree_active_shipping) | Spree integration for Shopify's active_shipping gem
+| [spree_static_content](https://github.com/spree-contrib/spree_static_content) | Manage static pages for Spree |
+| [spree-product-assembly](https://github.com/spree-contrib/spree-product-assembly) | Adds oportunity to make bundle of products |
+| [spree_editor](https://github.com/spree-contrib/spree_editor) | Rich text editor for Spree with Image and File uploading in-place |
+| [spree_recently_viewed](https://github.com/spree-contrib/spree_recently_viewed) | Recently viewed products in Spree |
+| [spree_wishlist](https://github.com/spree-contrib/spree_wishlist) | Wishlist extension for Spree |
+| [spree_sitemap](https://github.com/spree-contrib/spree_sitemap) | Sitemap Generator for Spree |
+
Performance
----------------------
-You may notice that your Spree store runs slowly in development enviornment. This can be because in development each asset (css and javascript) is loaded separately. You can disable it by adding the following line to `config/environments/development.rb`.
+You may notice that your Spree store runs slowly in development environment. This can be because in development each asset (css and javascript) is loaded separately. You can disable it by adding the following line to `config/environments/development.rb`.
```ruby
config.assets.debug = false
```
@@ -202,20 +233,20 @@
Contributing
----------------------
Spree is an open source project and we encourage contributions. Please review the
-[contributing guidelines](CONTRIBUTING.md)
+[contributing guidelines](https://github.com/spree/spree/blob/master/.github/CONTRIBUTING.md)
before contributing.
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
Here are some ways **you** can contribute:
* by using prerelease versions / master branch
* by reporting [bugs](https://github.com/spree/spree/issues/new)
* by [translating to a new language](https://github.com/spree/spree_i18n/tree/master/config/locales)
-* by writing or editing [documentation](http://guides.spreecommerce.com/developer/contributing.html#contributing-to-the-documentation)
+* by writing or editing [documentation](http://guides.spreecommerce.org/developer/contributing.html#contributing-to-the-documentation)
* by writing [specs](https://github.com/spree/spree/labels/need_specs)
* by writing [needed code](https://github.com/spree/spree/labels/feature_request) or [finishing code](https://github.com/spree/spree/labels/address_feedback)
* by [refactoring code](https://github.com/spree/spree/labels/address_feedback)
* by reviewing [pull requests](https://github.com/spree/spree/pulls)
* by verifying [issues](https://github.com/spree/spree/labels/unverified)