Updated README

.forgejo/workflows/build_release.yml

@@ -19,7 +19,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           push: true
-          tags: forgejo.neshweb.net/ci-docker-images/unlighthouse-docker:${{ github.ref_name }}, forgejo.neshweb.net/ci-docker-images/unlighthouse-docker:latest
+          tags: forgejo.neshweb.net/ci-docker-images/unlighthouse:${{ github.ref_name }}, forgejo.neshweb.net/ci-docker-images/unlighthouse:latest
 
   release:
     needs: [build]

README.md

@@ -1,3 +1,30 @@
-# Docker image to run lighthouse, but without non-privileged user
+# unlighthouse Docker Image
 
-Uses the full node:20-bookwork image instead of slim due to issues with GitLab lighthouse Docker
+Image based on `node:20.10.0-bookworm` with `chromium` and `unlighthouse` preinstalled.
+
+It can be used for benchmarking a given site with lighthouse and to generate corresponding reports with ease.
+
+## Usage
+
+The unlighthouse cli can be used by running the command `unlighthouse` inside the container
+
+```shell
+unlighthouse-ci --site "https://preview.firq.dev/"
+```
+
+It is recommended to provide a `unlighthouse.config.ts` to reduce the amount of CLI arguments needed.
+
+An example config can be found here:
+
+```typescript
+export default {
+    puppeteerOptions: {
+        args: ["--no-sandbox", "--disable-setuid-sandbox"],
+    },
+    ci: {
+        budget: 90,
+        buildStatic: true
+    },
+    outputPath: "unlighthouse-reports",
+}
+```