From a58e59c43b4c28eaee5b2adc4c009a1b0146012c Mon Sep 17 00:00:00 2001 From: cupcakearmy Date: Thu, 9 Mar 2023 02:30:33 +0100 Subject: [PATCH] readme --- README.md | 10 +++++++++- docker-compose.yaml | 4 ++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 60d704a..d5127dd 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,16 @@ Simple docker image that syncs your Github repos to a given Gitea server. It tak ## Quick Start -```yaml +Create a `docker-compose.yaml` and `.env` (see `.env.sample`). Create and insert tokens and you are ready to go. +```yaml +version: '3.8' + +services: + sync: + image: cupcakearmy/gitea-sync + restart: unless-stopped + env_file: .env ``` ## Configuration diff --git a/docker-compose.yaml b/docker-compose.yaml index 9ea2876..056033f 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,7 +1,11 @@ +# FOR DEVELOPMENT ONLY +# See README.md for an example + version: "3.8" services: job: + image: cupcakearmy/gitea-sync build: . env_file: .env