kjuulh/cuddle
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

chore: update readme
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source 
Signed-off-by: kjuulh <contact@kjuulh.io>
This commit is contained in:
Kasper Juul Hermansen 2024-05-04 22:29:38 +02:00
parent ff2353f0d1
commit 232ab93af7
Signed by: kjuulh
GPG Key ID: 57B6E1465221F912
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -38,7 +38,9 @@ Cuddle is a purely composition based tool, it means that it allows splitting
cross cutting needs into many small chunks which can then be included in your cross cutting needs into many small chunks which can then be included in your
service. service.
The way the services are usually created is that usually all the field are templated, or setup with default configurations just to give a hint that those features are available. The way the services are usually created is that usually all the field are
templated, or setup with default configurations just to give a hint that those
features are available.
```nickel ```nickel
let { Vars, .. } = import "github/kjuulh/cuddle" in let { Vars, .. } = import "github/kjuulh/cuddle" in
@ -63,7 +65,7 @@ let { GoPlan, .. } = import "github/kjuulh/cuddle-go-service-plan" in
deployment = { deployment = {
dev = { dev = {
cron = { cron = {
schedule = "* 0 * * *" schedule = "* 0 * * *",
http = "/refresh-cache" http = "/refresh-cache"
} }
env = { env = {
@ -80,7 +82,8 @@ let { GoPlan, .. } = import "github/kjuulh/cuddle-go-service-plan" in
} & Vars & GoPlan } & Vars & GoPlan
``` ```
A component has the same setup, but includes a different key to define what it requires A component has the same setup, but includes a different key to define what it
requires
```nickel ```nickel
let { Vars, Component .. } = import "github/kjuulh/cuddle" in let { Vars, Component .. } = import "github/kjuulh/cuddle" in
@ -102,7 +105,7 @@ let { Vars, Component .. } = import "github/kjuulh/cuddle" in
} & Vars & Component } & Vars & Component
``` ```
A plan is usually a composition of other components. A plan is usually a composition of other components.
```nickel ```nickel
let { Vars, Component, .. } = import "github/kjuulh/cuddle" in let { Vars, Component, .. } = import "github/kjuulh/cuddle" in