aingel/README.md

An interactive CLI tool with angel-themed greetings and blessings

# Angel

An interactive CLI tool with angel-themed greetings and blessings.

## Features

- ✨ Interactive CLI with beautiful ASCII art welcome screen
- 👋 Angel greetings with personalized messages
- 🌟 Random angel blessings to brighten your day
- 📅 Daily inspirational messages that change based on the date
- 🛍️ Virtual shop displaying magical celestial items
- 📦 Package information display

## Installation

### Global Installation (recommended for CLI usage)

```bash
npm install -g aingel
```

After installation, you can run the CLI by simply typing:

```bash
angel
```

### Local Installation (for use as a library)

```bash
npm install aingel
```

## Usage

### As a CLI Tool

Simply run the command to launch the interactive menu:

```bash
angel
```

The CLI provides an interactive menu with the following options:
- Receive a blessing
- Get a personalized greeting
- View daily message
- Browse celestial shop
- Package information
- Exit

### As a Library

```javascript
const angel = require('aingel');

// Get a personalized greeting
console.log(angel.greet('Maisy')); 
// Output: Hello Maisy, your guardian angel is watching over you!

// Get a random blessing
console.log(angel.bless());
// Output: May light guide your path (or another random blessing)
```

## API

### greet(name)

Returns a greeting message from an angel.

- `name` (string, optional): The name to greet. Defaults to 'friend'.
- Returns: (string) The greeting message.

### bless()

Generates a random angel blessing.

- Returns: (string) A random blessing.

## Publishing to NPM

To publish this package to NPM:

1. Create an NPM account if you don't have one: https://www.npmjs.com/signup
2. Login to NPM from your terminal: `npm login`
3. Publish the package: `npm publish --access=public`

**Note**: The package is now using the name 'aingel' which should be unique on npm.

## Development

To modify this package:

1. Clone the repository
2. Install dependencies: `npm install`
3. Make your changes
4. Test your changes: `npm start`

## License

ISC