Skip to content

Commit 94f2f0e

Browse files
committed
Add README.md with installation instructions, usage examples, and supported holidays
1 parent 7ec0c91 commit 94f2f0e

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# is-us-holiday-light
2+
3+
[![NPM](https://img.shields.io/npm/v/eslint-plugin-import-monorepo.svg "NPM package version")](https://www.npmjs.com/package/is-us-holiday-light)
4+
[![NPM](https://img.shields.io/npm/dt/eslint-plugin-import-monorepo.svg "NPM package downloads")](https://www.npmjs.com/package/is-us-holiday-light)
5+
6+
`is-us-holiday-light` is a lightweight JavaScript library to check if a given date is a US holiday.
7+
8+
## Installation
9+
10+
You can install the library using npm:
11+
12+
```bash
13+
npm install is-us-holiday-light
14+
```
15+
16+
Or using yarn:
17+
18+
```bash
19+
yarn add is-us-holiday-light
20+
```
21+
22+
## Usage
23+
24+
```javascript
25+
const isUsHoliday = require('is-us-holiday-light');
26+
27+
const date = new Date('2023-07-04');
28+
console.log(isUsHoliday(date)); // true, because it's Independence Day
29+
```
30+
31+
## Supported Holidays
32+
33+
- New Year's Day
34+
- Martin Luther King Jr. Day
35+
- Presidents' Day
36+
- Memorial Day
37+
- Independence Day
38+
- Labor Day
39+
- Columbus Day
40+
- Veterans Day
41+
- Thanksgiving Day
42+
- Christmas Day
43+
44+
## Contributing
45+
46+
Contributions are welcome! Please open an issue or submit a pull request.
47+
48+
## License
49+
50+
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)