github_link_creator

README

GitHub Link Card Creater

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

---

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.

Instalation

using as CLI, you should install folowing command.

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

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

Official Client

This page creates an HTML tag that reads the link card to the repository. You can just put it in Markdown's blog.

https://ghlinkcard.com

Client repository here.

Contributing

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