Skip to content

Generates random, unidentifiable names for any purpose

License

Notifications You must be signed in to change notification settings

Bikossor/anonymus

Repository files navigation

anonymus

Generates random, unidentifiable names for any purpose

Build Status Codacy Badge npm bundle size (minified + gzip) npm GitHub issues GitHub closed issues GitHub

Installation

Node.js environment

npm i anonymus --save

Browser environment

Include this line in your HTML (preferably in the body; here's why) and you can obtain anonymus via the jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/anonymus@1"></script>

or the unpkg CDN:

<script src="https://unpkg.com/anonymus@1"></script>

or you can download the latest version of anonymus here.

Usage

Node.js environment

const anonymus = require("anonymus");

Node.js environment + Browser environment

console.log(anonymus.create());
//=> ['Orange panda']

console.log(anonymus.create());
//=> ['Green hawk']

console.log(anonymus.create());
//=> ['Blue sheep']

console.log(anonymus.create(5));
//=> ['Red hummingbird',
//    'White frog',
//    'Pink jellyfish',
//    'Sapphire kangaroo',
//    'Black dog']

console.log(anonymus.create(anonymus.sizeMax));
//=> Creates all unique possibilities.

Upgrading

You can read the upgrade guide here.

Changelog

You can read the changelog here.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL-3.0 License - see here for more details.