Skip to content

Commit

Permalink
documentation: Better README
Browse files Browse the repository at this point in the history
  • Loading branch information
jlenon7 committed Oct 28, 2021
1 parent 3536aa4 commit 9c822f4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,22 @@ npm install -g @jlenon7/templating

### Commands

> Format any string that matches the regex {{ NAME }} in the templates folder path.
### Help

> See all commands and tips from templating.
```bash
templating --help
```

### Generate

> Templating will always look for environment variables first and then set the local fields, and format
> any string that matches the regex {{ NAME }} in the templates folder path.
```bash
templating generate ./manifest/templates --set IMAGE_TAG=my-dockerhub-image:latest
```

> manifest/templates/config-map.yml
```yml
Expand Down Expand Up @@ -77,12 +92,6 @@ spec:
memory: 500Mi
```
> Templating will always look for environment variables first and then set the local fields.
```bash
templating generate ./manifest/templates --set IMAGE_TAG=my-dockerhub-image:latest
```

---
<p align='center'>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jlenon7/templating",
"version": "1.0.2",
"version": "1.0.3",
"description": "",
"license": "MIT",
"author": "João Lenon",
Expand Down

0 comments on commit 9c822f4

Please sign in to comment.