Skip to content

Commit a04a014

Browse files
Update README.md
1 parent a483569 commit a04a014

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,47 @@
1-
# goplater
1+
# Goplater
22

3-
Goplater is a commandline programm that templates files by using local and also remote files.
3+
Goplater is a Go commandline programm that helps you template your files.
44

55
## Getting Started
6+
7+
Download the `latest` binaries from the Release Page.
8+
Make it executable with `chmod +x goplater` and run it for the first time.
9+
10+
Use the `goplater template` command to template files:
11+
12+
```bash
13+
./goplater template TEMPLATE.md -o README.md
14+
```
15+
16+
This will create a new file called `README.md` in your current working directory.
17+
18+
## Usage
19+
20+
Take a look at this `TEMPLATE.md` file:
21+
22+
```markdown
23+
{{{ #://examples/TEMPLATE.md }}}
24+
```
25+
26+
Notice the `{{{ #://... }}}` and `{{{ @://... }}}`, these are used to include local and remot files in your Template respectively.
27+
This Template will then include `examples/data.json` and `docker-compose.yaml` (from [Secured Signal API](https://github.com/CodeShellDev/secured-signal-api/blob/main/docker-compose.yaml)) in its File Content.
28+
29+
Which results in:
30+
31+
```markdown
32+
{{{ !#://examples/TEMPLATE.md }}}
33+
```
34+
35+
## Contributing
36+
37+
Found a bug or just want to change or add something?
38+
Feel free to open up an issue or a PR!
39+
40+
## Support
41+
42+
Like this Project? Or just want to help?
43+
Why not ⭐️ this Repo? :)
44+
45+
## License
46+
47+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)