Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 1.45 KB

README.md

File metadata and controls

84 lines (53 loc) · 1.45 KB
Raw

Business Card

A command-line business card that displays my contact information and social links.

Mitul Patel's Business Card

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js version 14.16 or higher
  • npm (comes with Node.js) or yarn package manager

Note: This package is built with TypeScript and uses modern JavaScript features, so make sure you have a compatible Node.js version installed.

Installation

You can run this package using npx:

npx bittricky

Or install it globally:

yarn global add bittricky

Usage

After installing globally, simply run:

bittricky

Options

  • --no-color: Disable colors in output
  • --help: Show help information
  • --version: Show version information

Development

  1. Clone the repository:
git clone https://github.com/bittricky/business-card.git
cd business-card
  1. Install dependencies:
yarn install
  1. Start development mode:
yarn dev
  1. Build the package:
yarn build

Testing

  • Run tests: yarn test
  • Run tests with coverage: yarn test:coverage
  • Run tests with specific path: yarn test:path <path-to-test-file>

Publishing

  1. Update the version in package.json
  2. Run yarn publish

License

MIT