Skip to content

Getting Started

Best Codes edited this page Jul 26, 2024 · 2 revisions

Getting started

About

Best-Holiday aims to make it easier for developers to interact with holidays in their applications. It can be used via the npm package or through the CDN for browser use.

The list of holidays can be found in src/index.ts. Holidays have four attributes:

  • name: Name of the holiday
  • date: Date of the holiday
  • country: Country where the holiday is
  • type: Type of the holiday

Installation

Installing Best-Holiday is simple.

npm

In your project directory, run:

npm install best-holiday

yarn

In your project directory, run:

yarn add best-holiday

For browser use, include this script tag in your HTML document:

<script src="https://cdn.jsdelivr.net/npm/best-holiday@latest/dist/browser/best-holiday.min.js"></script>
Clone this wiki locally