github_link_creator

github_link_creator copied to clipboard

GitHub Link Card Creater

GitHub Link Card Creator lets you generate GitHub images has links to repositories.

:mag_right: Overview

GitHub Link Card Creator lets you generate GitHub images has links to your repositories. This card is useful to guide to your repository in blogs etc.

:pencil: Official WEB Client

here !!

https://ghlinkcard.com

Instalation

using as CLI, you should install

$ go get "github.com/po3rin/github_link_creator/cmd/repoimg"

You can also install from here https://github.com/po3rin/github_link_creator/releases

Usage

CLI Mode

this lets you generate repository card in local.

repoimg -n po3rin/gotree

Server Mode

set environment valiable S3_BUCKET_NAME. this is target bucket to store image.

$ go build
$ ./github_link_creator
$ curl localhost:8080/v1/images/<username>/<reponame>

When raising the upper limit of API call of GitHub, You should set environment valiable GITHUB_CLIRNT_ID & GITHUB_SECRET.

GitHub REST API v3 Documents https://developer.github.com/v3/#rate-limiting

WEB Client Repository

Contributing

You're most welcomed! Welcome pull request and issues.