add readme
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
2022-12-29 02:59:32 +01:00
parent a4c39c00d0
commit cb3c15abbc

View File

@@ -1,5 +1,21 @@
# Char
Char is an organizations best friend, it helps with code sharing when either
using a multi-repo strategy or mono repo. The goal of the project is to
facilitate sharing of presets and plugins to reduce the required complexity
developers have to take on.
This project is best suited with a standard library of plugins (which serves the
function of libraries), as well `kjuulh/bust` which is a platform agnostic
CI/task setup
This is in very early stages, and for now it officially supports scaffolding.
## Example
The `examples` folder shows how to load plugins, though presets are still
pending.
```yaml
# file: .char.yml
registry: git.front.kjuulh.io