2.2.0 โ€ข Published 2 years ago

additrio v2.2.0

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
2 years ago

AddiTrio Function ๐Ÿš€๐Ÿ”ข๐ŸŽ‰

Shields.io NPM Badge GitHub top language Code style: black Accessibility: Color-Blind Friendly

Welcome to the official documentation of the incredibly versatile and utterly mesmerizing AddiTrio function! ๐ŸŽŠ

Did you ever wish to add not two, but three numbers in JavaScript? AddiTrio is here to make your wildest dreams come true! ๐ŸŒˆ๐Ÿ’ฅ

Table of Contents ๐Ÿ“š

Installation ๐Ÿ“ฅ

You can use either the npm package manager or Yarn to install AddiTrio.

npm install additrio

Using Yarn:

yarn add additrio

Usage ๐ŸŽฎ

import { additrio } from 'additrio';

console.log(additrio(1, 2, 3)); // outputs 6
console.log(additrio(1, 2)); // outputs 3

Examples ๐Ÿ“–

// Adding three numbers
console.log(additrio(3, 4, 5)); // outputs 12

// Adding two numbers, third one is optional
console.log(additrio(10, 20)); // outputs 30

// Using negative numbers
console.log(additrio(-1, -2, -3)); // outputs -6

Contributing ๐Ÿง‘โ€๐Ÿ’ป

We absolutely love contributions! ๐Ÿ˜ If you'd like to contribute to the project, please follow these steps:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Before submitting a PR, please ensure to pass all tests and adhere to our coding standards! โญ

Tests ๐Ÿงช

We use Jest for our tests. Run them with:

Using npm:

npm test

Using yarn:

yarn test

All code changes require accompanying tests! ๐Ÿš€

License ๐Ÿ“œ

This software is UNLICENSED. ๐Ÿ˜ฑ Yes, you read that correctly, dear developer.

We've worked tirelessly day and night to create this masterpiece we call AddiTrio. This function wasn't written over a cup of coffee during a commercial break. No sir/madam, it was a journey filled with blood, sweat, and tears (okay, maybe no blood, but you get the idea). ๐Ÿ‘ทโ€โ™€๏ธ๐Ÿ‘ทโ€โ™‚๏ธ๐ŸŒ™

So, before you consider "borrowing" our hard work for your weekend hackathon, or that side project you promised your friend, just remember - everyone has to make a living. We might not be selling this function for cold, hard cash, but we did put a piece of our soul into it. ๐Ÿ˜Œ๐Ÿ’–

In short: Do NOT use this function without explicit permission from us, the authors. Unauthorized copying, modification, distribution, or any other unpermitted use is not allowed. Seriously. Don't be that person. ๐Ÿšซ๐Ÿ”

If you'd like to use this function or discuss potential licensing options, feel free to get in touch! We're generally nice people, and we don't bite. Unless, of course, you try to steal our code. ๐Ÿ˜Š๐Ÿ”ช

Final Thoughts ๐ŸŒ 

We hope you find AddiTrio as exciting and useful as we do! It's a small step for a developer, but a giant leap for their efficiency! โœจ

Happy Coding! ๐Ÿ–ฅ๏ธ

2.2.0

2 years ago

2.1.0

2 years ago

1.0.0

2 years ago