Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 1.31 KB

README.md

File metadata and controls

61 lines (39 loc) · 1.31 KB

npm

polish-random-username

🍣 A TypeScript/JavaScript plugin to generate polish random usernames based on polish language.

Requirements

This plugin does not include TypeScript or tslib as a dependency, you must install those yourself.

Install

Using npm:

npm install polish-random-username

Usage

Create a project and import the plugin:

import { getRandomUsername } from "polish-random-username";

or

const { getRandomUsername } = require("polish-random-username");

Then you can call it like this:

const username = getRandomUsername();
console.log(username); //for example: Szczęśliwy Jaguar

Issues

If you enountered an issue, please open new one on GitHub.

Issues and bugs are appreciated and could be following:

  • wrong username generation
  • wrong username validation
  • wrong output
  • wrong gender recognition
  • wrong last letter recognition
  • problems with installing package
  • problems with used dependencies

Meta

CONTRIBUTING

LICENSE (MIT)