Skip to content

Commit

Permalink
Add getting started example to README
Browse files Browse the repository at this point in the history
  • Loading branch information
cjnosal committed Oct 31, 2019
1 parent b8ce315 commit 6c39dde
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ combine the library and template to compose the final document.
- interpolate: apply a snippet to the template
- compose: interpolate for all snippets defined in a set of scenarios

# getting started
1) generate a library from your collection of opsfiles
`manifer import -r -p ./ops-dir -o ./new-lib.yml`
2) view the generated scenarios
`manifer list -l new-lib.yml`
3) add scenarios for your common use cases, which can define variables or invoke other scenarios
`manifer add -l new-lib.yml -n use_case -d "thing I need frequently" -s "dependency_name" -- -v foo=bar -o extra-op.yml`
4) inspect the scenario you created
`manifer inspect -l new-lib.yml -s use_case`
5) use your new scenario to modify a template
`manifer compose -l new-lib.yml -t base.yml -s use_case`

# subcommands
## import
```
Expand Down

0 comments on commit 6c39dde

Please sign in to comment.