UNPKG

githubinator

Version:

Fetching Data from https://github.com

57 lines (44 loc) 1.46 kB
<div align="center"> <p> <a href="https://github.com"><img src="https://cdn.discordapp.com/attachments/735840008900051031/813835706781663322/github_PNG15.png" width="350"></a> </p> <p> <a href="https://www.npmjs.com/package/githubinator"><img src="https://img.shields.io/npm/v/githubinator?maxAge=3600" alt="NPM version" /></a> <a href="https://www.npmjs.com/package/githubinator"><img src="https://img.shields.io/npm/dt/githubinator?maxAge=3600" alt="NPM downloads" /></a> </p> <p> <a href="https://www.npmjs.com/package/githubinator"><img src="https://nodei.co/npm/githubinator.png?downloads=true&stars=true" alt="NPM Banner"></a> </p> </div> ## Install ```sh $ npm i githubinator ``` ## Setup ```js const git = require('githubinator'); ``` ## Example ```js (async function() { let user = await git.get('AngeloCore'); console.log(user.name); //Angelo II let repo = await git.getRepo('AngeloCore', 'src-bot'); console.log(repo.description); //The Test bot for SRC })() ``` ## Endpoints |Value|Param| |-|-| |get|Username/Org Name| |getRepo|Username, Repo| |getRepoForks|Username, Repo| |getUserFollowers|Username| |getFollowing|Username| |getUserRepos|Username| |getGist|Github Gist ID| ## Changelog - Added getGist method <hr> ## Contact [Youtube](https://www.youtube.com/channel/UCxxK71QFN4_PrBhCFmH2Jmw), [Discord](https://discord.gg/5JtyYqW)