From 5fdbea4e299b7130b7f507b7dabf26c21b3c2c41 Mon Sep 17 00:00:00 2001 From: Matthew Thompson Date: Thu, 17 May 2018 11:49:57 -0400 Subject: [PATCH 1/2] Adding basic howto for README.md for snapshot update --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 34baed7..c2411c2 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,16 @@ No `.solidarity` file found for this project. Would you like to create one? (Y/ Custom rule-sets can be created by modifying the `.solidarity` file by hand, or by creating a solidarity plugin for a given technology. [See documentation](https://infinitered.github.io/solidarity/) for how you can create your own. +## How to update my snapshot rules? +Given there is already a `.solidarity` file present, then you can run `solidarity snapshot [rule]` + +```sh +$ solidarity snapshot cli node +``` + +Solidarity will follow up with aditional questions to help drill down your new snapshot rule. + + ## Cross Platform Solidarity works with Mac/Linux/Windows environments. CI tests all rules with each platform on every update. From 69d15098e9ee6715b0f285506508f8f3d6e3b99b Mon Sep 17 00:00:00 2001 From: Matthew Thompson Date: Thu, 17 May 2018 11:58:16 -0400 Subject: [PATCH 2/2] More info in the readme around snapshot update. --- README.md | 2 +- docs/_sidebar.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c2411c2..e6e381c 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ No `.solidarity` file found for this project. Would you like to create one? (Y/ Custom rule-sets can be created by modifying the `.solidarity` file by hand, or by creating a solidarity plugin for a given technology. [See documentation](https://infinitered.github.io/solidarity/) for how you can create your own. -## How to update my snapshot rules? +## How do I update my snapshots? Given there is already a `.solidarity` file present, then you can run `solidarity snapshot [rule]` ```sh diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 8b98b69..9c20a1b 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -4,6 +4,7 @@ - [How do I use it?](#how-do-I-use-it) - [How do I update it?](#how-do-i-update-it-to-my-machine-specs) - [How do I create my first snapshot?](#how-do-I-create-my-first-snapshot) + - [How do I update my snapshots?](#how-do-I-update-my-snapshots) - [Supported Systems](#supported-systems) - [Additional Support](#support) - [Additional Info](#additional-info)