From 85faf856d049c8074ce71bea5f1f1468a317df5a Mon Sep 17 00:00:00 2001 From: Gregory Ballantine Date: Thu, 20 Jul 2017 12:07:45 -0400 Subject: [PATCH] Updated the readme --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 24096c7..7ffd860 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,42 @@ -# salt-formula-manager +# Salt Formula Manager + +Tool to automate the downloading of Salt formulas + +## 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: + +* Downloading formulas from multiple sources +* Keeping formula management to one single configuration file +* Avoiding needing to modify the Salt master config file to add new formula sources + +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 + +TODO - this needs to be done sometime... + +## Configuration + +TODO - this needs to be done sometime... + +## License + +This program is licensed under the Mozilla Public License, version 2.0 (I'm not a license guru, if this needs to be changed to comply with other licenses, I'll gladly change it) + +## Contact + +Email me at: brotherballantine@gmail.com + +Or you can find me on: +* [Mastodon](https://mastodon.rocks/@brotherballan) +* [Google+](https://plus.google.com/+GregoryBallantine1) -Tool to automate the downloading of Salt formulas \ No newline at end of file