1.0.0 • Published 7 months ago
@0x63/angel v1.0.0
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)
npm install -g @0x63/angelAfter installation, you can run the CLI by simply typing:
angelLocal Installation (for use as a library)
npm install @0x63/angelUsage
As a CLI Tool
Simply run the command to launch the interactive menu:
angelThe 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
const angel = require('@0x63/angel');
// 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:
- Create an NPM account if you don't have one: https://www.npmjs.com/signup
- Login to NPM from your terminal:
npm login - Publish the package:
npm publish --access=public
Note: The package is scoped with @0x63 prefix. If you want to publish under a different scope, update the name in package.json.
Development
To modify this package:
- Clone the repository
- Install dependencies:
npm install - Make your changes
- Test your changes:
npm start
License
ISC
1.0.0
7 months ago