From 6033c4e16eab767c1d8b635fc2e5c41ac5efb8f2 Mon Sep 17 00:00:00 2001 From: jaedle Date: Sat, 9 Mar 2019 14:27:21 +0100 Subject: [PATCH] add description on interval --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bf17bf3..c342a89 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ## Description -This script mirrors automatically the public repositories from a github-user or github-organization to your gitea server. +This script mirrors automatically the public repositories from a github-user or github-organization to your gitea server. It will - once started - create a mirrored repository under a given token for a gitea user fully automatically. Example: @@ -38,6 +38,8 @@ docker container run \ jaedle/mirror-to-gitea:latest ``` +This will a spin up a docker container running infinite which will try to mirror all your repositories once every hour to your gitea server. + ### Parameters - `GITHUB_USERNAME` name of user or organization which public repos should be mirrored