Installation
This is a Node.js module available through the npm registry.
Before installing, download and install Node.js. Node.js 0.10 or higher is required.
If this is a brand new project, make sure to create a package.json first with
the npm init command.
Installation is done using the
npm install command:
$ npm install better-usernamesFeatures
- Sort word category order
- Custom formatters
- Capitalization helper
- Word seperation
- Focus on high performance
Quick Start
The quickest way to get started with random-usernames is to use the module in a script and output a username as shown below:
Install the executable:
$ npm install -g better-usernames Make an index.js file and give it the following contents:
const generateUsername = require('better-usernames');
console.log(generateUsername());Test the application:
$ node index.jsVerify that the console output is as expected.
Examples
To view the examples, clone the Random Usernames repo and install the dependencies:
$ git clone git://github.com/joeymalvinni/random-usernames.git
$ cd random-usernamesThen run whichever example you want:
$ node examples/advancedTests
To run the test suite, run npm test:
$ npm testContributing
Authors
The author of random-usernames is Joey Malvinni
License
<<<<<<< HEAD
Apache 2.0
5b8c6e513f0e4a6573761bf6b8859fcb1dd6657c