https://github.com/fraction/guess-who
Extract names from usernames and email addresses with Node.js.
https://github.com/fraction/guess-who
Last synced: about 1 year ago
JSON representation
Extract names from usernames and email addresses with Node.js.
- Host: GitHub
- URL: https://github.com/fraction/guess-who
- Owner: fraction
- License: other
- Created: 2014-08-06T05:55:39.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2015-11-07T03:15:35.000Z (over 10 years ago)
- Last Synced: 2024-08-09T06:09:48.906Z (almost 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 920 KB
- Stars: 5
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Guess Who
Extract names from usernames and email addresses with Node.js.
## Installation
To add this to your existing project, install this as an NPM module.
```sh
npm install guess-who
```
Otherwise, clone the repo, install dependencies, and run the example.
```sh
git clone https://github.com/fraction/guess-who.git && cd guess-who
npm install
node examples/name-from-email
```
## Usage
After you've installed `guess-who`, require it and use it!
```js
gw = require('guess-who');
gw('johndoe', function (username, name) {
console.log('"' + username + '" is actually "' + name.join(' ') + '"');
// "johndoe" is actually "john doe"
});
```
Take a look at the examples directory to see what else can be done.
## Support
Please [open an issue](https://github.com/fraction/guess-who/issues/new) for questions and concerns.
## Contributing
Fork the project, commit your changes, and [open a pull request](https://github.com/fraction/guess-who/compare/).