aa-sheesh/README.md

CLI tool to display my business card in the terminal

# npx aa-sheesh

**aa-sheesh** is a CLI tool that displays a stylish, interactive business card in your terminal. It showcases your contact details and provides an option for users to open their default email client to contact you directly.

## Features

- **Stylish Terminal Output:** Uses [chalk](https://www.npmjs.com/package/chalk) and [boxen](https://www.npmjs.com/package/boxen) to display your business card in a visually appealing box.
- **Interactive Prompt:** Incorporates [inquirer](https://www.npmjs.com/package/inquirer) to allow users to choose whether to email you or exit.
- **Seamless Email Integration:** Leverages [open](https://www.npmjs.com/package/open) to launch the default email client with a pre-addressed mailto link.
- **Cross-Platform Compatibility:** Works on Windows, macOS, and Linux.

## Installation & Usage

### Running via npx (No Global Installation Required)

You can run the CLI tool directly using npx:

```bash
npx aa-sheesh
```

## Contributing
Contributions are welcome! Follow these steps to help improve the project:

1. Fork the Repository:
Click the "Fork" button on GitHub to create your own  of the repository.

2. Clone Your Fork:

```bash


git clone https://github.com/yourusername/aa-sheesh.git
cd aa-sheesh
```

3. Create a New Branch:

```bash


git checkout -b feature/your-feature-name
```
4. Implement Your Changes:
Make your changes, add new features, or fix bugs. Test your changes thoroughly.

5. Commit Your Changes:

Use clear, descriptive commit messages:

```bash


git commit -m "Add [feature/bugfix]: brief description of your changes"
```
6. Push to Your Fork:

```bash


git push origin feature/your-feature-name
```
7. Submit a Pull Request:
Open a pull request on the original repository, describing your changes in detail. Your pull request will be reviewed and merged if approved.

## License
This project is licensed under the [MIT License](./LICENSE). See the LICENSE file for details.

## Contact
- Developer: Aashish Singh
- Email: aashishs4912345@gmail.com
- GitHub: Aa-sheesh