ASCII Tea Cup

Welcome to ASCII Tea Cup! This delightful npm package allows you to print charming cups of tea in ASCII art right to your console. It's designed with simplicity in mind, making it perfect for beginners who are just dipping their toes into the vast world of programming and npm packages.

What It Does

ASCII Tea Cup lets you instantly generate tea cups in ASCII format. Whether you need a little decoration for your console applications or just want to enjoy a virtual cup of tea, this package is here for you. With just a simple command, you can generate one or many tea cups to brighten your day.

Target Audience

This package is targeted at beginners and those new to the JavaScript and npm ecosystem. We aim to provide a fun and simple example of what npm packages can do, offering an easy-to-understand codebase and straightforward functionality. It's a great starting point for those looking to learn more about creating and publishing their own packages.

Installation

To download and use ASCII Tea Cup, you'll need Node.js and npm installed on your computer. Once you have those set up, simply run the following command in your terminal:

npm install gym-tea

This command pulls the latest version of ASCII Tea Cup from the npm registry and installs it in your project.

Usage

After installing, you can use ASCII Tea Cup in your JavaScript file as follows:

const printTeaCup = require('@gym-tea');

// To print a single cup of tea
printTeaCup(1);

// To print multiple cups of tea
printTeaCup(5);

Just replace the number with how many cups of tea you would like to print.

Contributing

We love contributions! If you have ideas on how to improve ASCII Tea Cup or add new features, please feel free to fork the repository, make your changes, and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

Final Note

ASCII Tea Cup is more than just a simple npm package; it's a doorway to learning and creativity in the coding world. We hope it brings a little joy and a lot of learning into your coding journey!

Happy Coding!