mirror of
https://github.com/kennethreitz/bake.git
synced 2026-06-05 23:00:17 +00:00
cleanup
This commit is contained in:
+51
@@ -0,0 +1,51 @@
|
||||
# github-username [](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)
|
||||
Reference in New Issue
Block a user