diff --git a/README.md b/README.md index a02aaa0..f5b1f2c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,70 @@ # github-to-gogs + +## Summary +Is a small program that migrate stars made on github projects to self owned gogs/gitea instance + ## Howto + Build -``` +```text go build ``` -Run +Configure in github-to-gogs.ini ``` +[global] +request_timeout=1200s +user_agent="Golang" + +[github] +stars_pages="https://api.github.com/users/%s/starred?page=%d" +max_pages_number=8 +auth_username="user" +auth_password="pass" +content_type="application/x-www-form-urlencoded" + +[gogs] +username="user" +dest_username="user_or_org" +repo_url_tmpl="https://gogs.example.com/api/v1/repos/%s/%s" +orgs_url_tmpl="https://git.paulbsd.com/api/v1/orgs/%s" +migrate_url="https://gogs.example.com/api/v1/repos/migrate" +auth_token="token xxxx" +content_type="application/json" +mirror=true +``` + +Run +```text ./github-to-gogs -configfile github-to-gogs.ini ``` + ## License -BSD \ No newline at end of file +```text +Copyright (c) 2019, PaulBSD +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The views and conclusions contained in the software and documentation are those +of the authors and should not be interpreted as representing official policies, +either expressed or implied, of the fuelprices project. +``` \ No newline at end of file