# 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

*Only works for users that have their email publicly listed on their profile.*


## Install

```
$ npm install --save 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)
