ethinic-username-generator
v1.0.1
Published
a simple package that help in generating thinic username
Downloads
106
Maintainers
Readme
Random Name Generator: A lightweight and versatile utility for generating random descriptive names, ethnic names, and personalized usernames. Perfect for projects requiring unique identifiers or creative name generation.
Features: Random Descriptive Names: Combines random adjectives and nouns for names like Amazing Explorer or Brave Knight. Ethnic Name Generator: Generates names from Igbo, Yoruba, and Hausa origins. Custom Usernames: Appends a random adjective to a provided name for personalization.
Installation Install the package using npm: npm i ethinic-username-generator
Usage Import the Library const { generate, ethnicNameGenerator, username } = require('ethinic-username-generator');
Generate a Random Name: console.log(generate());
Generate Ethnic-Specific Names: console.log(ethnicNameGenerator("igboNames")); // Example Output: "Chinonso" // Example Output: "Epic Warrior"
console.log(ethnicNameGenerator("yorubaNames")); // Example Output: "Adeola"
console.log(ethnicNameGenerator("hausaNames")); // Example Output: "Aisha"
Create a Custom Username: console.log(username("Elvis")); // Example Output: "Elvis Dynamic"
Here's a polished and concise README tailored for an npm package:
Random Name Generator A lightweight and versatile utility for generating random descriptive names, ethnic names, and personalized usernames. Perfect for projects requiring unique identifiers or creative name generation.
Features Random Descriptive Names: Combines random adjectives and nouns for names like Amazing Explorer or Brave Knight. Ethnic Name Generator: Generates names from Igbo, Yoruba, and Hausa origins. Custom Usernames: Appends a random adjective to a provided name for personalization. Installation Install the package using npm:
bash Copy code npm install random-name-generator Usage Import the Library javascript Copy code const { generate, ethnicNameGenerator, username } = require('random-name-generator');
- Generate a Random Name javascript Copy code console.log(generate()); // Example Output: "Epic Warrior"
- Generate Ethnic-Specific Names javascript Copy code console.log(ethnicNameGenerator("igboNames")); // Example Output: "Chinonso"
console.log(ethnicNameGenerator("yorubaNames")); // Example Output: "Adeola"
console.log(ethnicNameGenerator("hausaNames")); // Example Output: "Aisha" 3. Create a Custom Username javascript Copy code console.log(username("Elvis")); // Example Output: "Elvis Dynamic"
API Reference generate() Generates a random name by combining an adjective and a noun.
Returns: A string.
ethnicNameGenerator(nametype) Generates a random ethnic name.
Parameters: nametype (string): The ethnic group. Options: igboNames, yorubaNames, hausaNames. Returns: A string.
username(name) Appends a random adjective to the given name.
Parameters: name (string): The user's name. Returns: A string.
Contributing Contributions are welcome!
Fork the repository. Create a feature branch. Submit a pull request.