Browse Source

add description on interval

pull/1/head
jaedle 5 years ago
parent
commit
6033c4e16e
1 changed files with 3 additions and 1 deletions
  1. +3
    -1
      README.md

+ 3
- 1
README.md

@ -7,7 +7,7 @@
## Description ## 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. It will - once started - create a mirrored repository under a given token for a gitea user fully automatically.
Example: Example:
@ -38,6 +38,8 @@ docker container run \
jaedle/mirror-to-gitea:latest 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 ### Parameters
- `GITHUB_USERNAME` name of user or organization which public repos should be mirrored - `GITHUB_USERNAME` name of user or organization which public repos should be mirrored

Loading…
Cancel
Save