Skip to content

Latest commit

 

History

History
32 lines (29 loc) · 1.39 KB

README.md

File metadata and controls

32 lines (29 loc) · 1.39 KB
Raw

Gitcard

Template cards to showcase your GitHub proficiency on blogs and websites :bowtie:

npm

Gitcard

Installation </>

npm install gitcardjs --save

Usage

  1. Download the desired CSS theme (Light or Dark) from here and link it as a Stylesheet, uses Bulma under the hood.
import './gitcard-light.css';
  1. Require the Package
const Gitcard = require('gitcardjs');
  1. Call the package by passing github authorization token with scope read:user from here and github username
Gitcard('token', 'capturemathan').then(function(res){
    console.log(res)
    /*
    <div class="columns"><div class="column is-one-quarter">...</div></div>
    */
   Pass the res to any of the container tags using `innerHTML` methods like `dangerouslySetInnerHTML` in REACT
})
  1. Refer to the example directory for further details.

Open Source License

Read the license here