## Npm-xodivorce

### 👀 Preview
<img src="./images/npm-xodivorce-preview.png" alt="npm-xodivorce-preview">

> **Run this in your terminal to view the card.**
   ```bash
     npx xodivorce
   ```

#### A sleek, interactive CLI business card - showcasing contact links, resume also more right from your terminal.

[![status](https://img.shields.io/badge/status-active-brightgreen.svg?style=flat)](https://github.com/xodivorce/npm-xodivorce/)
[![version](https://img.shields.io/badge/version-v1.1.0-yellow.svg?style=flat)](https://github.com/xodivorce/npm-xodivorce/)
[![PRs](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat)](https://github.com/xodivorce/npm-xodivorce/)

> **🥰 Like this project? Please consider giving it a Star (🌟) on GitHub to show us your appreciation. Thank you!**

### ⚡️ Technologies Used
![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white)
![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

### 🛠️ Installation
   Want to get started quickly? Follow the instructions below to install and run the project on your system.

1. **Clone the repository**
   - Clone the repository to your local machine:
     ```bash
     # Clone using SSH
     git clone git@github.com:xodivorce/npm-xodivorce-preview.git
     # Or using HTTPS
     git clone https://github.com/xodivorce/npm-xodivorce.git
     ```

2. **Set up your environment**
   - Ensure you have [Node.js](https://nodejs.org/) version 14 or higher installed.

3. **Install dependencies**
   - Navigate to the project directory and install the required packages:
     ```bash
     npm install
     ```

4. **Run the tool:**
   - Run the tool from your terminal:

      **Locally:**
      ```bash
      # Link the package for local development
      npm link
      # Run the CLI tool
      xodivorce
      # For quick testing, use the command `node index.mjs`
      ```

      **Production (Public):**
      ```bash
      # Log in to your npm account
      npm login
      # Publish the package to npm
      npm publish --access public
      ```

🐞 **Got Ideas or Spotted a Bug?**  
   Don’t be shy! [*Open an issue*](https://github.com/xodivorce/npm-xodivorce/issues) to discuss new features, enhancements, or any bugs you find. Your feedback is golden!!

### 📄 License
   This project is licensed under the [**MIT License**](LICENSE.txt). You are free to use, modify, and distribute this code for personal or commercial purposes, as long as you include the original copyright and license notice in any copies or substantial portions of the software.

> 🧠 Follow me on [Instagram](https://www.instagram.com/xodivorce) or check out more projects at [xodivorce.in](https://www.xodivorce.in)

<br></br>

****

An open-source project - crafted with ❤️ by **xodivorce**