2.0.0 • Published 10 months ago

how-awesome-am-i v2.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

how-awesome-am-i

how-awesome-am-i is a fun and simple JavaScript library that calculates a person's awesomeness based on their name. The awesomeness score is consistent and deterministic — so it’s the same every time you check!

Features

  • Deterministic: The awesomeness score for a given name will always be the same.
  • Fun & Simple: Just pass a name, and the library will return how awesome they are!
  • Small & Lightweight: No dependencies, just pure fun.

Installation

You can install the package via npm or yarn.

Using npm

npm install how-awesome-am-i

Using yarn

yarn add how-awesome-am-i

Usage

After installing, you can start using the library by requiring it in your project.

Example Usage in Node.js

const howAwesomeAmI = require('how-awesome-am-i');
console.log(howAwesomeAmI('Alice'));`  
// Output: `'Alice is 59% awesome! Keep rocking!'
console.log(howAwesomeAmI('Bob'));`  
// Output: `'Bob is 72% awesome! Keep rocking!'
console.log(howAwesomeAmI('Charlie'));`  
// Output: `'Charlie is 85% awesome! Keep rocking!'

Usage with ES6 Modules

If you're using ES6 module imports, you can do the following:

import howAwesomeAmI from 'how-awesome-am-i';
console.log(howAwesomeAmI('Alice'));`  
// Output: `'Alice is 59% awesome! Keep rocking!'

API

howAwesomeAmI(name)

  • name: The name of the person to evaluate (string).
  • returns: A string with the awesomeness score, like "{name} is {score}% awesome! Keep rocking!"

Example

howAwesomeAmI('David');`  
// Output: `'David is 77% awesome! Keep rocking!'

Contributing

Feel free to fork the project, make improvements, and submit pull requests. Issues and feature requests are also welcome.

License

This project is licensed under the MIT License. See the LICENSE file for details.

2.0.0

10 months ago

1.0.5

10 months ago

1.0.4

10 months ago

1.0.2

10 months ago

1.0.1

10 months ago

1.0.0

10 months ago