This commit is contained in:
2019-09-17 13:20:42 -04:00
parent d211d1dc34
commit bef10ce4c9
8352 changed files with 568242 additions and 51 deletions
+51
View File
@@ -0,0 +1,51 @@
# github-username [![Build Status](https://travis-ci.org/sindresorhus/github-username.svg?branch=master)](https://travis-ci.org/sindresorhus/github-username)
> Get a GitHub username from an email address
## Install
```
$ npm install github-username
```
## Usage
```js
const githubUsername = require('github-username');
githubUsername('sindresorhus@gmail.com').then(username => {
console.log(username);
//=> 'sindresorhus'
});
```
## API
### githubUsername(email, [token])
Returns a `Promise` for the username.
#### email
Type: `string`
Email address for the user of whom you want the username.
#### token
Type: `string`
GitHub [personal access token](https://github.com/settings/tokens/new).
## Related
- [github-username-cli](https://github.com/sindresorhus/github-username-cli) - CLI for this module
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)