Add a README

.gitlab-ci.yml

@@ -1,10 +1,22 @@
-build:
+build:amd64:
   image: debian:latest
   before_script:
     - apt-get update
     - apt-get install -y valac libwebkit2gtk-4.0-dev
   script:
-    - valac --pkg gtk+-3.0 --pkg webkit2gtk-4.0 captcha-helper.vala
+    - valac --pkg gtk+-3.0 --pkg webkit2gtk-4.0 signal-captcha-helper.vala
   artifacts:
     paths:
-      - captcha-helper
+      - signal-captcha-helper
+
+build:arm64:
+  image: debian:latest
+  tags: [arm-builder]
+  before_script:
+    - apt-get update
+    - apt-get install -y valac libwebkit2gtk-4.0-dev
+  script:
+    - valac --pkg gtk+-3.0 --pkg webkit2gtk-4.0 signal-captcha-helper.vala
+  artifacts:
+    paths:
+      - signal-captcha-helper

README.md

@@ -0,0 +1,29 @@
+# Signal Captcha Helper
+
+Signal's captcha system is designed to be used in an embedded browser. This utility
+provides that and the bare minimum to parse the resulting token.
+
+## pre-compiled binary
+
+*no need to install valac*
+
+* [linux amd64](https://gitlab.com/api/v4/projects/27947268/jobs/artifacts/main/raw/signal-captcha-helper?job=build%3Aamd64)
+* [linux arm64](https://gitlab.com/api/v4/projects/27947268/jobs/artifacts/main/raw/signal-captcha-helper?job=build%3Aarm64)
+
+## build
+
+*if you can't or don't want to use the pre-compiled binaries*
+
+```
+valac --pkg gtk+-3.0 --pkg webkit2gtk-4.0 signal-captcha-helper.vala
+```
+
+## use
+
+The captcha token is output to standard out when the program completes, so you probably
+want to launch this tool from the terminal so you can see the output. There are no
+options (for now), so just invoke it directly:
+
+```
+./signal-captcha-helper
+```