You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-9Lines changed: 24 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,30 +8,35 @@
8
8
9
9
Industry-leading Holiday and Event API for JavaScript/TypeScript. Over 5,000 holidays and thousands of descriptions. Trusted by the World’s leading companies. Built by developers for developers since 2011.
10
10
11
-
# Authentication
11
+
## Authentication
12
+
12
13
Access to the Holiday and Event API requires an API Key. You can get for one for FREE [here](https://apilayer.com/marketplace/checkiday-api#pricing), no credit card required! Note that free plans are limited. To access more data and have more requests, a paid plan is required.
13
14
14
-
# Installation
15
+
##Installation
15
16
16
17
```console
17
-
$ npm install --save holiday-event-api
18
+
npm install --save holiday-event-api
18
19
```
19
20
20
-
# Example Usage
21
+
## Example Usage
22
+
23
+
### Authentication
21
24
22
-
## Authentication
23
25
Simply construct an instance of `Holidays` and pass your API Key like this:
26
+
24
27
```ts
25
28
import { Holidays } from'holiday-event-api';
26
29
27
30
// Get a FREE API key from https://apilayer.com/marketplace/checkiday-api#pricing
28
31
const api =newHolidays({ apiKey: '<Your API Key Here>' });
29
32
```
30
33
31
-
## Example Project
34
+
### Example Project
35
+
32
36
You can find a fully-functioning example project [here](example).
0 commit comments