@crayon.js/color-support/README.md

Detect terminal color support

<font size="6"><p align="center"><b>🖍️ Crayon.js color support</b></p></font>
<hr />

## :books: About
##### This package is extension for [crayon.js](https://github.com/crayon-js/crayon) however it can still be used by other packages.

### Installation
```bash
npm install @crayon.js/color-support #yarn add @crayon.js/color-support
```

## Syntax
```ts
interface CrayonColorSupport {
	threeBitColor: boolean
	fourBitColor: boolean
	highColor: boolean
	trueColor: boolean
}
```

## Usage
```ts
import { getColorSupport, supportedColors, getWindowsVersion } from '@crayon.js/color-support';

const support = getColorSupport(); // detect terminal color support
const cached = supportedColors(); // cached getColorSupport (it just returns cached object)
const windowsVersion = getWindowsVersion(); // Reusable function [version (7/8/10...), versionId (14931...)], empty if detected system is not Windows
```

## Usage with crayon.js
```ts
import crayon from 'crayon.js'; // it'll still work with packages that extend crayon instance as its config is global
import { getColorSupport } from '@crayon.js/color-support';

crayon.config.colorSupport = getColorSupport();
```

## :handshake: Contributing
#### Feel free to add any commits, issues and pull requests

## :memo: Licensing
#### This project is available under MIT License conditions.