diff --git a/README.md b/README.md index b6b6e6e..3963d5c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,38 @@ -[![Build and Publish](https://github.com/cooperspencer/gickup/actions/workflows/docker.yml/badge.svg)](https://github.com/cooperspencer/gickup/actions/workflows/docker.yml) -# GICKUP -![gickup](https://github.com/cooperspencer/gickup/blob/main/gickup.png) +
+ + Website + • + GitHub + • + Docs + +
+ ++ + + +
+ + + +## What is GICKUP? +Gickup is a tool that allows you to clone/mirror repositories from one hoster to another. +This is useful if you want to have a backup of your repositories on another hoster or to a local server. + + +### Supported Source and Destionations You can clone/mirror repositories from: - Github - Gitlab @@ -16,7 +43,7 @@ You can clone/mirror repositories from: - Sourcehut - Any -You can clone/mirror them to: +You can clone/mirror repositories to: - Github - Gitlab - Gitea @@ -25,7 +52,10 @@ You can clone/mirror them to: - Sourcehut - Local -[Official Documentation](https://cooperspencer.github.io/gickup-documentation/) + +If your hoster is not listed, feel free to open an issue and I will add it. + + ## How to make a configuration file [Here is an example](https://github.com/cooperspencer/gickup/blob/main/conf.example.yml)