From 7731e74e5ccd6c1c68de726f7fbcb9cba95dc716 Mon Sep 17 00:00:00 2001 From: jacobherrington Date: Mon, 12 Nov 2018 08:16:10 -0600 Subject: [PATCH 1/3] Add a table of contents --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 97c44c6bedd..6ef25c1e923 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ - [Join our Slack](http://slack.solidus.io/) ([solidusio.slack.com](http://solidusio.slack.com)) - [solidus-security](https://groups.google.com/forum/#!forum/solidus-security) mailing list +## Table of Contents +1. [Summary](#summary) +2. [Demo](#demo) +3. [Getting Started](#getting-started) +4. [Installation Options](#installation-options) +5. [Developing Solidus](#developing-solidus) +6. [Contributing](#contributing) + ## Summary Solidus is a complete open source ecommerce solution built with Ruby on Rails. From 00873b96e86f8d32d016c4dadc1fb6bbc7ef4a89 Mon Sep 17 00:00:00 2001 From: jacobherrington Date: Mon, 12 Nov 2018 08:17:31 -0600 Subject: [PATCH 2/3] Standardize headers --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6ef25c1e923..04c7df99379 100644 --- a/README.md +++ b/README.md @@ -97,8 +97,7 @@ As part of running the above installation steps, you will be asked to set an adm The best way to ask questions is via the [#support channel on the Solidus Slack](https://solidusio.slack.com/messages/support/details/). -Installation options --------------------- +## Installation options Instead of a stable build, if you want to use the bleeding edge version of Solidus, use this line: @@ -130,8 +129,7 @@ bundle exec rake spree_sample:load There are also options and rake tasks provided by [solidus\_auth\_devise](https://github.com/solidusio/solidus_auth_devise). -Performance ------------ +## Performance You may notice that your Solidus store runs slowly in development mode. This can be because in development each CSS and JavaScript is loaded as a separate @@ -156,8 +154,7 @@ Add `gem 'turbolinks', '~> 5.0.0'` into your `Gemfile` (if not already present) **CAUTION** Please be aware that Turbolinks can break extensions and/or customizations to the Solidus admin. Use at own risk. -Developing Solidus ------------------- +## Developing Solidus * Clone the Git repo From 302718a51a4fcb7b96b5794a038a157a2dc50624 Mon Sep 17 00:00:00 2001 From: jacobherrington Date: Mon, 12 Nov 2018 08:29:35 -0600 Subject: [PATCH 3/3] Add performance to table of contents --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 04c7df99379..dc0c409d50f 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,9 @@ 2. [Demo](#demo) 3. [Getting Started](#getting-started) 4. [Installation Options](#installation-options) -5. [Developing Solidus](#developing-solidus) -6. [Contributing](#contributing) +5. [Performance](#performance) +6. [Developing Solidus](#developing-solidus) +7. [Contributing](#contributing) ## Summary @@ -258,8 +259,7 @@ A list can be found at [extensions.solidus.io](http://extensions.solidus.io/). If you want to write an extension for Solidus, you can use the [solidus_cmd](https://www.github.com/solidusio/solidus_cmd.git) gem. -Contributing ------------- +## Contributing Solidus is an open source project and we encourage contributions. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before contributing.