Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 1.72 KB

README.md

File metadata and controls

53 lines (44 loc) · 1.72 KB

trending-github

Simple API for getting trending repositories on Github

Travis npm version npm downloads npm license eslint

Installation

npm install trending-github --save

Usage

const trending = require('trending-github');

trending()
  .then(repos => console.log(repos));

//=> [{
//=>   author: 'asciimoo',
//=>   name: 'wuzz',
//=>   href: 'https://github.com/asciimoo/wuzz',
//=>   description: 'Interactive cli tool for HTTP inspection',
//=>   language: 'Go',
//=>   stars: 966,
//=>   forks: 20,
//=>   starsInPeriod: 153
//=> }, ... ]
const trending = require('trending-github');

trending('weekly', 'javascript')
  .then(repos => console.log(repos));

//=> [{
//=>   author: 'freeCodeCamp',
//=>   name: 'freeCodeCamp',
//=>   href: 'https://github.com/freeCodeCamp/freeCodeCamp',
//=>   description: 'The https://freeCodeCamp.com open source codebase and curriculum. Learn to code and help nonprofits.',
//=>   language: 'JavaScript',
//=>   stars: 229260,
//=>   forks: 9289
//=>   starsInPeriod: 42
//=> }, ... ]

License

MIT © Daniel Eckermann