Moved the ToC in the readme above the Overview

This commit is contained in:
Gregory Ballantine 2017-07-20 12:10:24 -04:00
parent 85faf856d0
commit 9a9e03f6b6

View File

@ -2,6 +2,14 @@
Tool to automate the downloading of Salt formulas Tool to automate the downloading of Salt formulas
### Table of Contents
1. [Overview - what you just read...](#overview)
2. [Usage - How to use this thing](#usage)
2. [Configuration - Getting this thing ready to roll](#configuration)
4. [License - Licensing information](#license)
5. [Contact - How to contact me](#contact)
## Overview ## Overview
The goal of this tool is provide a flexible, yet powerful tool to manage Salt formulas. It aims to support many different configurations in an intuitive manner, such as, but not limited to: The goal of this tool is provide a flexible, yet powerful tool to manage Salt formulas. It aims to support many different configurations in an intuitive manner, such as, but not limited to:
@ -12,14 +20,6 @@ The goal of this tool is provide a flexible, yet powerful tool to manage Salt fo
Indeed, SaltStack are working on a tool, Salt Package Manager, that aims to do similar things. However, that tool feels a little "hacky", in my opinion, and doesn't use some of the tools that are already available to us, such as git/GitHub, and it requires the use of hosting packages out of a separate repository. Granted, that approach does have its positives, but I felt that I needed something a little lighter than that solution. To each their own :) Indeed, SaltStack are working on a tool, Salt Package Manager, that aims to do similar things. However, that tool feels a little "hacky", in my opinion, and doesn't use some of the tools that are already available to us, such as git/GitHub, and it requires the use of hosting packages out of a separate repository. Granted, that approach does have its positives, but I felt that I needed something a little lighter than that solution. To each their own :)
#### Table of Contents
1. [Overview - what you just read...](#overview)
2. [Usage - How to use this thing](#usage)
2. [Configuration - Getting this thing ready to roll](#configuration)
4. [License - Licensing information](#license)
5. [Contact - How to contact me](#contact)
## Usage ## Usage
TODO - this needs to be done sometime... TODO - this needs to be done sometime...