![License](https://img.shields.io/github/license/pr357/is-freebsd?style=flat-square)
![issues](https://img.shields.io/github/issues/pr357/is-freebsd?style=flat-square)
![Weekly downloads](https://img.shields.io/npm/dw/is-freebsd?label=weekly%20downloads&style=flat-square)
![Total downloads](https://img.shields.io/npm/dt/is-freebsd?label=total%20downloads&style=flat-square)
![Minified size](https://img.shields.io/bundlephobia/min/is-freebsd?label=minified%20size&style=flat-square)
![Version](https://img.shields.io/npm/v/is-freebsd?style=flat-square)

# is-freebsd

A tool to check if the operating system is FreeBSD or not

# Installation

```bash
npm install is-freebsd
```

Or, if you prefer yarn

```bash
yarn add is-freebsd
```

# Usage

```javascript
const { isFreeBSD } = require('is-freebsd');

// If the OS that the program is executing in is FreeBSD then it returns true
console.log(isFreeBSD()); // true
```

# Contributing

Contributions are welcome. See the [contribution guide](https://github.com/pr357/is-freebsd/blob/main/CONTRIBUTING.md) for more info.

# License

This software is licensed under the [MIT License](https://choosealicense.com/licenses/mit/). See the [LICENSE](https://github.com/pr357/is-freebsd/blob/main/LICENSE) for more info.