diff --git a/README.md b/README.md index 531a44d..834a605 100644 --- a/README.md +++ b/README.md @@ -20,15 +20,14 @@ The server is maintained separately. This repo contains only the egg client. ## Run an Egg -Clone the repo and use Docker Compose — it pulls the pre-built image from the registry automatically: +Download the compose file and start it — no building required: ```bash -git clone https://git.hexadual.io/rocobo/GCP-Dot.git -cd GCP-Dot +curl -O https://git.hexadual.io/rocobo/GCP-Dot/raw/branch/main/docker-compose.yml docker compose up -d ``` -The egg will immediately start sending one trial per second and persist its ID across restarts. +Docker will pull the pre-built image from the registry automatically. The egg will immediately start sending one trial per second and persist its ID across restarts. ## Environment Variables @@ -39,25 +38,13 @@ The egg will immediately start sending one trial per second and persist its ID a The auto-generated ID is derived from a SHA-256 hash stored at `/data/egg_id` — mount a volume there to keep it stable across restarts. -## Project Structure +## Published Image +The egg image is built and published automatically on every push to `main`: + +```bash +docker pull git.hexadual.io/rocobo/gcp-dot-egg:latest ``` -GCP/ -├── egg.py # Egg client — all logic (~70 lines) -├── requirements.txt # requests==2.31.0 -├── Dockerfile -├── docker-compose.yml -└── .gitea/workflows/ - └── docker.yml # CI: builds and pushes egg image on every push to main -``` - -## Published Images - -Every push to `main` builds and publishes to the Gitea container registry via Gitea Actions: - -| Image | Pull | -|---|---| -| Egg | `docker pull git.hexadual.io/rocobo/gcp-dot-egg:latest` | ## How the Analysis Works