README.md in spree-4.2.7 vs README.md in spree-4.3.0.rc1
- old
+ new
@@ -1,130 +1,93 @@
+<a href="https://spreecommerce.org">
+ <img src="https://raw.githubusercontent.com/spree/spree/master/guides/src/images/features/spree_header%402x.png" alt="Spree Commerce - complete open source e-commerce solution built with Ruby on Rails. PWA, Global Commerce, Headless Commerce" />
+</a>
+
# Spree Commerce
-<a href="https://guides.spreecommerce.org/release_notes/4_1_0.html"><img src="https://spreecommerce.org/wp-content/uploads/2020/03/spree-4_1-mobile-first-customizable-ux-1400x800-0_20.png" /></a>
-
-* Join our Slack at [slack.spreecommerce.org](http://slack.spreecommerce.org/)
-* [Contact us](https://spreecommerce.org/contact/) to start a new project or get tech support
-* [DEMO](https://spreecommerce.org/spree-commerce-demo-explainer/) of the new Spree UX introduced in Spree 4.1
-* [9 good reasons to upgrade to Spree 4.1](https://spreecommerce.org/spree-commerce-4-1-is-now-available-9-reasons-to-upgrade-or-use-it-for-a-new-e-commerce-project/) or use it for a new project
* [Success Stories](https://spreecommerce.org/stories/)
-* [Integrations](https://spreecommerce.org/integrations/)
-* [Extensions](https://github.com/spree/spree#extensions)
* [Documentation](http://guides.spreecommerce.org)
-* [Roadmap](https://github.com/spree/spree/milestones?direction=asc&sort=due_date&state=open)
-* [Maintenance Policy](https://github.com/spree/spree/wiki/Maintenance-Policy)
+* [Integrations](https://spreecommerce.org/integrations/)
+* [Join our Slack community](http://slack.spreecommerce.org/)
+* [Support](https://guides.spreecommerce.org/support)
-[](https://badge.fury.io/rb/spree) [](https://circleci.com/gh/spree/spree/tree/master)
-[](https://codeclimate.com/github/spree/spree)
-[](https://codeclimate.com/github/spree/spree/test_coverage)
-[](http://slack.spreecommerce.org)
+[](https://badge.fury.io/rb/spree) [](https://circleci.com/gh/spree/spree/tree/master) [](https://codeclimate.com/github/spree/spree/test_coverage)
-**Spree** is a complete open source e-commerce solution built with Ruby on Rails. It
-was started by Sean Schofield and is now developed by [Spark Solutions](http://sparksolutions.co). We're open to [contributions](#contributing).
+**Spree** is a complete open source e-commerce solution for global brands. It was started by Sean Schofield and is now developed by [Spark Solutions][spark]. We're open to [contributions](https://guides.spreecommerce.org/developer/contributing/).
-Spree consists of several different gems (modules), each of which are maintained
-in a single repository and documented in a single set of
-[online documentation](http://guides.spreecommerce.org/).
+## Key Features
-* **spree_api** ([REST API v2](https://guides.spreecommerce.org/api/v2) with [JavaScript / TypeScript SDK](https://github.com/spree/spree-storefront-api-v2-js-sdk) and [REST API v1](https://guides.spreecommerce.org/api/))
-* **spree_graphql** (GraphQL API - [coming soon](https://github.com/spree/spree/issues/9176))
-* **spree_frontend** (mobile-first, blazing fast and customizable storefront)
-* **spree_backend** (feature rich Admin Panel)
-* **spree_cmd** (command-line tools for developers)
-* **spree_core** (models, services & mailers, the basic components of Spree)
-* **spree_sample** (sample data for demo purposes)
+
+* **[Headless Commerce](https://spreecommerce.org/use-cases/headless-ecommerce-api/)** - build mobile apps or custom storefronts in any technology, [JS/TS SDK available](https://github.com/spree/spree-storefront-api-v2-js-sdk)
+* **[PWA](https://spreecommerce.org/use-cases/spree-pwa-progressive-web-application/)** - offline shopping experiences like native mobile apps
+* **[Mobile-first Storefront](https://spreecommerce.org/spree-commerce-demo-explainer/)** - modern, ultra fast and responsive storefront designed for great UX as well as SEO
+* **[Global Commerce](https://spreecommerce.org/use-cases/international-sales-demo/)** - multi currency and multi language support out of the box, different shipping methods / costs for different regions, advanced tax calculation
+* **Multi-Store** - host multiple brands / stores on one Spree instance with different branding, configuration, payment methods, shipping options, product catalogs etc
+* **[Multi-vendor marketplace](https://spreecommerce.org/use-cases/multi-vendor-marketplace-demo/)** - run your own marketplace with multiple suppliers with dedicated Supplier Dashboard
+* **Responsive Admin Panel** - manage and curate products, users, orders, returns, shipments & more
+* **Orders** - robust system for orders, shipments, returns and refunds
+* **Carts** - comprehensive and advanced discounts system
+* **Payments** - over 30 payment provider integration out of the box plus API to integrate any other gateway
+* **Run everywhere** - cloud, VPS, Docker, Kubernetes
+* **Battle Tested** - used by thousands of merchants around the globe in all categories since 2007!
+* **Fully customizable** - pick and choose parts you want to use and customize everything else (storefront, order processing, API, etc) to create unique solutions that your business requires
+* **More features available via extensions** - dozens of extensions built by community, ready for use for free!
+
+
+
## Demo
-Go to: https://demo.spreecommerce.org/
-Explore demo features: https://spreecommerce.org/spree-commerce-demo-explainer/
+See Spree in action: [demo.spreecommerce.org](https://demo.spreecommerce.org/)
Or fire up your own demo on Heroku:
[](https://heroku.com/deploy?template=https://github.com/spree/spree_starter)
Admin panel credentials for your own Heroku demo:
* login: `spree@example.com`
* password: `spree123`
-## Local Installation
+## Installation
### Option A - use Spree Starter with Docker
1. [Install Docker](https://docs.docker.com/get-docker/)
2. Download [Spree Starter](https://github.com/spree/spree_starter/archive/main.zip)
3. Unzip it
4. Run `bin/setup` in `spree_starter-main` directory
-### Option B - add Spree to an existing application
+### Option B - add Spree to an existing Ruby on Rails application
-1. [Please follow Add Spree to an existing Ruby on Rails application tutorial](https://guides.spreecommerce.org/developer/tutorials/existing_app_tutorial.html)
+1. [Please follow Add Spree to an existing Ruby on Rails application tutorial](https://guides.spreecommerce.org/developer/advanced/existing_app_tutorial.html)
-## Extensions
+## Documentation
-Spree Extensions provide additional features not present in the Core system.
+[Go to Spree Guides](https://guides.spreecommerce.org/)
-| Extension | Spree 3.2+ support | Description |
-| --- | --- | --- |
-| [spree_analytics_trackers](https://github.com/spree-contrib/spree_analytics_trackers) | [](https://travis-ci.org/spree-contrib/spree_analytics_trackers) | Adds support for Analytics Trackers (Google Analytics & Segment)
-| [spree_avatax_official](https://github.com/spree-contrib/spree_avatax_official) | [](https://travis-ci.org/spree-contrib/spree_avatax_official) | Improve your Spree store's sales tax decision automation with Avalara AvaTax
-| [spree_auth_devise](https://github.com/spree/spree_auth_devise) | [](https://travis-ci.org/spree/spree_auth_devise) | Provides authentication services for Spree, using the Devise gem.
-| [better_spree_paypal_express](https://github.com/spree-contrib/better_spree_paypal_express) | [](https://travis-ci.org/spree-contrib/better_spree_paypal_express) | This is the official Paypal Express extension for Spree.
-| [spree_braintree_vzero](https://github.com/spree-contrib/spree_braintree_vzero) | [](https://travis-ci.org/spree-contrib/spree_braintree_vzero) | Official Spree Braintree v.zero + PayPal extension |
-| [spree_contact_us](https://github.com/spree-contrib/spree_contact_us) | [](https://travis-ci.org/spree-contrib/spree_contact_us) | Adds Contact Us form |
-| [spree_digital](https://github.com/spree-contrib/spree_digital) | [](https://travis-ci.org/spree-contrib/spree_digital) | A Spree extension to enable downloadable products |
-| [spree_gateway](https://github.com/spree/spree_gateway) | [](https://travis-ci.org/spree/spree_gateway) | Payment Gateways (Stripe, Apple Pay, Braintree, Authorize.net and many others)
-| [spree_editor](https://github.com/spree-contrib/spree_editor) | [](https://travis-ci.org/spree-contrib/spree_editor) | Rich text editor for Spree with Image and File uploading in-place |
-| [spree_globalize](https://github.com/spree-contrib/spree_globalize) | [](https://travis-ci.org/spree-contrib/spree_globalize) | Adds support for model translations (multi-language stores)
-| [spree_i18n](https://github.com/spree-contrib/spree_i18n) | [](https://travis-ci.org/spree-contrib/spree_i18n) | I18n translation files for Spree Commerce
-| [spree-mollie-gateway](https://github.com/mollie/spree-mollie-gateway) | [](https://github.com/mollie/spree-mollie-gateway) | Official [Mollie](https://www.mollie.com) payment gateway for Spree Commerce. |
-| [spree-multi-domain](https://github.com/spree-contrib/spree-multi-domain) | [](https://travis-ci.org/spree-contrib/spree-multi-domain) | Multiple Spree stores on different domains - single unified backed for processing orders
-| [spree_multi_vendor](https://github.com/spree-contrib/spree_multi_vendor) | [](https://travis-ci.org/spree-contrib/spree_multi_vendor) | Spree Multi Vendor Marketplace extension |
-| [spree-product-assembly](https://github.com/spree-contrib/spree-product-assembly) | [](https://travis-ci.org/spree-contrib/spree-product-assembly) | Product Bundles |
-| [spree_recently_viewed](https://github.com/spree-contrib/spree_recently_viewed) | [](https://travis-ci.org/spree-contrib/spree_recently_viewed) | Recently viewed products in Spree |
-| [spree_related_products](https://github.com/spree-contrib/spree_related_products) | [](https://travis-ci.org/spree-contrib/spree_related_products) | Related products extension for Spree
-| [spree_social](https://github.com/spree-contrib/spree_social) |[](https://travis-ci.org/spree-contrib/spree_social) | Building block for spree social networking features (provides authentication and account linkage) |
-| [spree_sitemap](https://github.com/spree-contrib/spree_sitemap) | [](https://travis-ci.org/spree-contrib/spree_sitemap) | Sitemap Generator for Spree |
-| [spree_shared](https://github.com/spree-contrib/spree_shared) | [](https://travis-ci.org/spree-contrib/spree_shared) | Multi-tenancy for Spree using Apartment (per tenant databases) |
-| [spree_static_content](https://github.com/spree-contrib/spree_static_content) | [](https://travis-ci.org/spree-contrib/spree_static_content) | Manage static pages for Spree |
-| [spree_volume_pricing](https://github.com/spree-contrib/spree_volume_pricing) | [](https://travis-ci.org/spree-contrib/spree_volume_pricing) | It determines the price for a particular product variant with predefined ranges of quantities
-| [spree_wishlist](https://github.com/spree-contrib/spree_wishlist) | [](https://travis-ci.org/spree-contrib/spree_wishlist) | Wishlist extension for Spree |
+## Extensions
-## Developing Spree
+Extensions provide additional features and integrations for your Spree store
-Please [follow this guide](https://guides.spreecommerce.org/developer/tutorials/developing_spree.html)
+[Go to Extensions Directory](https://guides.spreecommerce.org/extensions/)
## Contributing
-Spree is an open source project and we encourage contributions. Please review the
-[contributing guidelines](https://github.com/spree/spree/blob/master/.github/CONTRIBUTING.md)
-before contributing.
+Spree is an open source project and we love contributions in any form - pull requests, issues, feature ideas!
-In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+Please review the [Contributing Guide](https://guides.spreecommerce.org/developer/contributing/)
-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](https://github.com/spree/spree/blob/master/.github/CONTRIBUTING.md)
-* 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)
-
## License
Spree is released under the [New BSD License](https://github.com/spree/spree/blob/master/license.md).
## About Spark Solutions
[][spark]
-[Spark Solutions][spark] is a software development agency specialized in Ruby on Rails, Spree Commerce and Javascript development. We’ve been leading Spree open-source efforts since 2016 as its core team. We also do client work. Our project teams consist of UX and UI designers, Software Engineers, Testers and Project Managers practicing agile project delivery. We’ll integrate our team with yours to jointly architect, deliver, maintain and scale the software products you need. You drive the project with requirements and acceptance testing and we help you deliver faster using industry-standard project management and comms best practices.
+[Spark Solutions][spark] is a full stack eCommerce agency specialized in Spree Commerce, Ruby on Rails and JavaScript. We’ve been leading Spree open-source efforts since 2016 as its core team. We also do client work. Our project teams consist of Designers, Software Engineers, Testers and Project Managers practicing agile project delivery. We’ll integrate our team with yours to jointly architect, deliver, maintain and scale the software products you need. You drive the project with requirements and acceptance testing and we help you deliver faster using industry-standard project management and comms best practices.
We are passionate about open source software.
We are [available for hire][spark].
-[spark]:http://sparksolutions.co?utm_source=github
+[spark]:https://sparksolutions.co?utm_source=github