summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElizabeth <me@liz.coffee>2025-05-26 14:48:42 -0700
committerElizabeth <me@liz.coffee>2025-05-26 14:48:42 -0700
commit3fb12c9e683e7c9fda3ddc7423f090b0265ffbb0 (patch)
tree85b0f7c371b0c06be780447c87dd9f5ff3dca6bb
parentd51c9d74857aca3c2f172609297266968bc7f809 (diff)
downloadci-3fb12c9e683e7c9fda3ddc7423f090b0265ffbb0.tar.gz
ci-3fb12c9e683e7c9fda3ddc7423f090b0265ffbb0.zip
Update README.md to trigger a hook update
-rw-r--r--README.md17
1 files changed, 6 insertions, 11 deletions
diff --git a/README.md b/README.md
index 4495934..5a8bffc 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,11 @@
-# lizci (⑅˘꒳˘)
+# @emprespresso/ci (⑅˘꒳˘)
-hi! this is lizci, built on top of [laminar](https://laminar.ohwg.net/docs.html), because while jenkins looks hot and classy,
-i prefer a simpler approach that i can extend on myself.
+this is my ci server, built on top of [laminar](https://laminar.ohwg.net/docs.html), because while the jenkins logo looks hot and classy, i want something to hack on myself.
-## how to use? (。•̀ᴗ-)✧
+## how to use it? (。•̀ᴗ-)✧
-add a script that generates the
-
-1. add a `.ci/ci.json` file to your repo
-2. point to your pipeline generator script
-3. push your code
+1. add a script that generates a valid serialized `pipeline` (as modeled in `model/pipeline.ts`) somewhere in your repo.
+2. add a `.ci/ci.json` with `{"worfklow": "<path_to_executable>"}`.
+3. push your code to src.liz.coffee.
4. watch the magic happen!
-
-made with love and deno~