Skip to content

Commit 359d588

Browse files
Update README.md
1 parent 4ddac0c commit 359d588

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ npm install colombian-holidays
1717

1818
## Usage
1919

20-
The default export is a function to get all the holidays for a given year, returning an array with the holidays for the requested year.
20+
The default export is a function to get all the holidays for a given year.
2121

2222
The `year` should be between 1583 and 4099 (see [Pascua](https://github.com/MauricioRobayo/pascua) package).
2323

@@ -231,9 +231,7 @@ If the year is omitted, by default the function will return the holidays for the
231231

232232
```js
233233
const currentYearHolidaysAsStrings = colombianHolidays();
234-
const currentYearHolidaysAsDates = colombianHolidays({
235-
valueAsDate: true,
236-
});
234+
const currentYearHolidaysAsDates = colombianHolidays({ valueAsDate: true });
237235
```
238236

239237
## Utils
@@ -242,7 +240,7 @@ The package provides two helper functions which can be imported from `lib/utils`
242240

243241
### isHoliday
244242

245-
Returns true if the given date is a colombian holiday, otherwise returns false.
243+
Returns `true` if the given date is a colombian holiday, otherwise returns `false`.
246244

247245
```js
248246
import { isHoliday } from "colombian-holidays/lib/utils/isHoliday";
@@ -258,7 +256,7 @@ if (isHoliday(date)) {
258256

259257
### holidaysWithinInterval
260258

261-
Returns an with the colombian holidays within two dates:
259+
Returns an array with the colombian holidays within two dates:
262260

263261
```js
264262
import { holidaysWithinInterval } from "colombian-holidays/lib/utils/holidaysWithinInterval";

0 commit comments

Comments
 (0)