better-usernames

1.5.2 • Public • Published


Build Status Apache 2.0 License Github contributors Snyk vulnerabilities PRs welcome Github contributors Snyk vulnerabilities PRs welcome


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-usernames

Features

  • 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.js

Verify 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-usernames

Then run whichever example you want:

$ node examples/advanced

Tests

To run the test suite, run npm test:

$ npm test

Contributing

Contributing Guide

Authors

The author of random-usernames is Joey Malvinni

List of all contributors

License

<<<<<<< HEAD Apache 2.0

Apache 2.0

5b8c6e513f0e4a6573761bf6b8859fcb1dd6657c

Package Sidebar

Install

npm i better-usernames

Weekly Downloads

3

Version

1.5.2

License

Apache-2.0

Unpacked Size

3.43 MB

Total Files

26

Last publish

Collaborators

  • joeymalvinni