Business Card

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

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, you can use the following commands:

# Display the business card
bittricky

# Open resume in default browser
bittricky resume

# Open showcase in default browser
bittricky showcase

Options

• --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

2. Install dependencies:

yarn install

3. Start development mode:

yarn dev

4. 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

You can publish a new version using one of the following commands:

# Patch version (1.0.0 -> 1.0.1)
yarn publish:patch

# Minor version (1.0.0 -> 1.1.0)
yarn publish:minor

# Major version (1.0.0 -> 2.0.0)
yarn publish:major

License

MIT

@author Mitul Patel