https://github.com/boneskull/conjecture
https://github.com/boneskull/conjecture
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/boneskull/conjecture
- Owner: boneskull
- License: other
- Archived: true
- Created: 2017-05-18T04:25:25.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-18T06:08:41.000Z (about 9 years ago)
- Last Synced: 2025-09-08T15:33:30.754Z (9 months ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# conjecture
> Guess Git author, email address, GitHub username, etc.
This module attempts to gather info from various Git config files, npm, and the host system.
## Requirements
- Node.js v4 or greater
## Install
```bash
$ npm install conjecture --save
```
## Example
```js
// each function returns a Promise
const {guessAuthor, guessEmail, guessGitHubUsername} = require('conjecture');
// guessGitHubUsername takes an optional "email" parameter
Promise.all([guessAuthor(), guessEmail(), guessGitHubUsername()])
.then(([author, email, githubUsername]) => {
console.log(author); // Christopher Hiller
console.log(email); // boneskull@boneskull.com
console.log(githubUsername); // boneskull
});
```
## License
© 2017 [Christopher Hiller](https://boneskull.com). Licensed Apache-2.0.