# github-index

> calculate the h-index, i10-index, and g-index according to repos' stars of github user

Latest version **1.1.1** (published 2016-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-index
pnpm add github-index
yarn add github-index
bun add github-index
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-08-06 |
| First published | 2016-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | flowmemo |
| Maintainers | flowmemo |

## Links

- npm: https://www.npmjs.com/package/github-index
- Repository: https://github.com/flowmemo/github-index
- Homepage: https://github.com/flowmemo/github-index#readme
- Issues: https://github.com/flowmemo/github-index/issues
- npm.io page: https://npm.io/package/github-index

## Dependencies (3)

- [h-index](https://npm.io/package/h-index.md) ^1.1.0
- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^2.2.1
- [lodash.escaperegexp](https://npm.io/package/lodash.escaperegexp.md) ^4.1.2

## Recent versions

- 1.1.1 (latest) — 2016-08-06
- 1.1.0 — 2016-08-06
- 1.0.0 — 2016-08-06

## README

# github-index
calculate the h-index, i10-index, and g-index according to github repos' stars of user

[![Travis branch](https://img.shields.io/travis/flowmemo/github-index/master.svg?style=flat-square)](https://travis-ci.org/flowmemo/github-index)
[![npm](https://img.shields.io/npm/v/github-index.svg?style=flat-square)](https://www.npmjs.com/package/github-index)

## Usage
`$ npm install github-index`

```js
var ghindex = require('.')
// this function return a promise
ghindex('tj').then(res => console.log(res))
// { sum: 65560, h: 83, i10: 168, repoCount: 241 }
```

## Note
It use [github api v3](https://developer.github.com/v3/). The rate limit is 60 requests per hour for unauthenticated requests. See https://developer.github.com/v3/#rate-limiting for details.

Don't take the result too seriously :)

## License
MIT © [flowmemo](http://weibo.com/flowmemo)

---
_Source: https://npm.io/package/github-index · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
