Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
davidovich authored Sep 3, 2019
1 parent f35d69c commit 392d115
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ GOBIN=./ gobin [your-go-repo-import]/summon[@wanted-version-or-branch]
Use-cases
---------

### Makefile library
### Makefile Library

In makefiles it can be useful to centralize certain libraries, notice how
summon returns the path ot where the resource was instantiated:
Expand Down Expand Up @@ -206,42 +206,50 @@ will yield:
myRenderedFileName
```

### Running a go binary
### Running A Binary

`summon run [executable]` allows to run executables declared in the config file

### Dumping the data at a location
### Dumping the Data at a Location

```
summon --all --out .dir
```

### Output a file to stdout
### Output a File to stdout

```
summon my-file -o-
```

### Output a template file non rendered
### Output a Template File Without Rendering

```
summon my-template -o- --raw
```

### List summon contents
### List Summon Contents

```
summon ls
summon ls --tree # pretty print hierarchy
```

### View data version information
### View Data Version Information

```
summon -v
```

### Configure Bash Completion

> New in v0.8.0
```
source <(summmon completion)
```

Alternatives
------------

Expand Down

0 comments on commit 392d115

Please sign in to comment.