aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorElizabeth Hunt <me@liz.coffee>2026-02-07 13:59:38 -0800
committerElizabeth Hunt <me@liz.coffee>2026-02-07 13:59:38 -0800
commit24fb1c119cdb40f84ef2d1733f549ef60c578770 (patch)
treeb24ac8a07ea13f15e9572b628d4264a2247c0671 /README.md
parent7908c833d2f12870cddf7801bb91d46a2007dcc1 (diff)
downloadci-24fb1c119cdb40f84ef2d1733f549ef60c578770.tar.gz
ci-24fb1c119cdb40f84ef2d1733f549ef60c578770.zip
Minor README updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 3 insertions, 7 deletions
diff --git a/README.md b/README.md
index f35ac0e..bd9adb7 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,8 @@
-# @emprespresso/ci (⑅˘꒳˘)
-
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.
-also! to scrap out pengueno :3
-
-## how to use it? (。•̀ᴗ-)✧
+## how to use?
-1. add a script that generates a valid serialized `pipeline` (as modeled in `model/pipeline.ts`) somewhere in your repo.
+1. add a binary that writes a valid serialized `pipeline` (as modeled in `model/pipeline.ts`) to stdout somewhere in your repo.
2. add a `.ci/ci.json` with `{"workflow": "<path_to_executable>"}`.
-3. push your code to src.liz.coffee.
+3. push your code.
4. watch the magic happen!