Skip to content

Commit 9d537c8

Browse files
Update README.md
1 parent 8a27060 commit 9d537c8

File tree

1 file changed

+84
-4
lines changed

1 file changed

+84
-4
lines changed

README.md

Lines changed: 84 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,96 @@ This will create a new file called `README.md` in your current working directory
2020
Take a look at this `TEMPLATE.md` file:
2121

2222
```markdown
23-
{{{ #://examples/TEMPLATE.md }}}
23+
Wow, look at this incredible file... 🥳
24+
25+
`cmd/root.go`:
26+
27+
```go
28+
package cmd
29+
30+
import (
31+
"os"
32+
33+
"github.com/spf13/cobra"
34+
)
35+
36+
var rootCmd = &cobra.Command{
37+
Use: "goplater",
38+
Short: "Go Template CLI",
39+
Long: `Go CLI Programm to Template files.`,
40+
// Uncomment the following line if your bare application
41+
// has an action associated with it:
42+
// Run: func(cmd *cobra.Command, args []string) { },
43+
}
44+
45+
func Execute() {
46+
err := rootCmd.Execute()
47+
if err != nil {
48+
os.Exit(1)
49+
}
50+
}
51+
52+
func init() {
53+
54+
}
2455
```
2556

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.
57+
You want the `docker-compose.yaml` file for Secured Signal API?
58+
Really? Here you go:
59+
60+
```yaml
61+
services:
62+
signal-api:
63+
image: bbernhard/signal-cli-rest-api:latest
64+
container_name: signal-api
65+
environment:
66+
- MODE=normal
67+
volumes:
68+
- ./data:/home/.local/share/signal-cli
69+
restart: unless-stopped
70+
networks:
71+
backend:
72+
aliases:
73+
- signal-api
74+
75+
secured-signal:
76+
image: ghcr.io/codeshelldev/secured-signal-api:latest
77+
container_name: secured-signal
78+
environment:
79+
API__URL: http://signal-api:8080
80+
SETTINGS__VARIABLES__RECIPIENTS:
81+
'[+123400002, +123400003, +123400004]'
82+
SETTINGS__VARIABLES__NUMBER: "+123400001"
83+
API__TOKENS: '[LOOOOOONG_STRING]'
84+
ports:
85+
- "8880:8880"
86+
restart: unless-stopped
87+
networks:
88+
backend:
89+
aliases:
90+
- secured-signal-api
91+
92+
networks:
93+
backend:
94+
```
95+
```
96+
97+
Notice the `{{ #://... }}}` and `{{ @://... }}}`, these are used to include local and remot files in your Template respectively.
98+
This Template will then include `examples/fs/INCREDIBLE.md` and `docker-compose.yaml` (from [Secured Signal API](https://github.com/CodeShellDev/secured-signal-api/blob/main/docker-compose.yaml)) in its File Content.
2899

29100
Which results in:
30101

31102
```markdown
32-
{{{ !#://examples/TEMPLATE.md }}}
103+
Wow, look at this incredible file... 🥳
104+
105+
{{{ #://examples/fs/INCREDIBLE.md }}}
106+
107+
You want the `docker-compose.yaml` file for Secured Signal API?
108+
Really? Here you go:
109+
110+
```yaml
111+
{{{ @://https://raw.githubusercontent.com/CodeShellDev/secured-signal-api/refs/heads/main/docker-compose.yaml }}}
112+
```
33113
```
34114

35115
## Contributing

0 commit comments

Comments
 (0)