Skip to content

Commit

Permalink
Communicating snapshot update feature in Readme (#204)
Browse files Browse the repository at this point in the history
* Adding basic howto for README.md for snapshot update

* More info in the readme around snapshot update.
  • Loading branch information
Matt Thompson authored and GantMan committed May 17, 2018
1 parent 434f3f0 commit f7f6d94
Showing 2 changed files with 11 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -71,6 +71,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 do I update my snapshots?
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.

1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,7 @@
- [How do I use it?](/README.md#how-do-I-use-it)
- [How do I update it?](/README.md#how-do-i-update-it-to-my-machine-specs)
- [How do I create my first snapshot?](/README.md#how-do-I-create-my-first-snapshot)
- [How do I update my snapshots?](#how-do-I-update-my-snapshots)
- [Supported Systems](/README.md#supported-systems)
- [Additional Support](/README.md#support)
- [Additional Info](/README.md#additional-info)

0 comments on commit f7f6d94

Please sign in to comment.