@kennyoliver/april-fools-tool/README.md

Is it April Fool's?

# :date: april-fools-tool

<a href="https://www.npmjs.com/package/@kennyoliver/april-fools-tool">
    <img src="https://img.shields.io/badge/april%20fools%20tool-CB3837?style=for-the-badge&logo=npm&labelColor=black&logoColor=CB3837" />
</a>

#### Is it April Fool's? :thinking:

Use this package to change your project's behavior if it's April Fool's! :stuck_out_tongue:

Be mischievous!

---


## :package: Installation
<a href="https://www.npmjs.com/package/@kennyoliver/april-fools-tool">
    <img src="https://img.shields.io/npm/dt/@kennyoliver/april-fools-tool.svg?label=april%2Dfools%2Dtool&&logoWidth=20&style=for-the-badge&labelColor=black&color=CB3837&&logo=npm" />
</a>

<br />

```
$ npm i --save @kennyoliver/april-fools-tool
```

---


## :bulb: Usage

#### :point_right: Require

```ts
const AFT = require("april-fools-tool");
```

---


## :sparkles: Features

##### :date: AprilFoolsBool

Check if it's April Fool's (April 1st)

```ts
console.log(AFT.AprilFoolsBool);
```

> ##### :date: IsToday
> 
> This is a shorthand alias for [AprilFoolsBool](#date-aprilfoolsbool)!
> 
> ```ts
> console.log(AFT.IsToday);
> ```

##### :memo: AprilFoolsMsg()

A short message dependent on the value of [AprilFoolsBool](#date-aprilfoolsbool)

```ts
console.log(AFT.AprilFoolsMsg());
```

---


## :handshake: Contributing!

#### If you'd like to contribute, feel free to make a PR!

---


Kenneth Oliver ©2022