# Duke3D Palette

[![NPM version][npm-version-image]][npm-url]
[![Build Status][build-status-image]][build-status-url]
[![Coverage Status][coverage-image]][coverage-url]
[![Known Vulnerabilities][vulnerabilities-image]][vulnerabilities-url]
[![Dependencies][dependencies-image]][dependencies-url]
[![Downloads][npm-downloads-image]][npm-url]
[![Install Size][install-size-image]][install-size-url]
[![Contributors][contributors-image]][contributors-url]
[![Pull Requests Welcome][pull-requests-image]][pull-requests-url]

A module for reading Duke Nukem 3D palette files.

## Note

This is a preview version of this module, it is not yet complete but should be fully functional.

## Usage

```javascript
var Palette = require("duke3d-palette");

TODO
```

## Installation

To install this module:
```bash
npm install duke3d-palette
```

[npm-url]: https://www.npmjs.com/package/duke3d-palette
[npm-version-image]: https://img.shields.io/npm/v/duke3d-palette.svg
[npm-downloads-image]: http://img.shields.io/npm/dm/duke3d-palette.svg

[build-status-url]: https://travis-ci.org/nitro404/duke3d-palette
[build-status-image]: https://travis-ci.org/nitro404/duke3d-palette.svg?branch=master

[coverage-url]: https://coveralls.io/github/nitro404/duke3d-palette?branch=master
[coverage-image]: https://coveralls.io/repos/github/nitro404/duke3d-palette/badge.svg?branch=master

[vulnerabilities-url]: https://snyk.io/test/github/nitro404/duke3d-palette?targetFile=package.json
[vulnerabilities-image]: https://snyk.io/test/github/nitro404/duke3d-palette/badge.svg?targetFile=package.json

[dependencies-url]: https://david-dm.org/nitro404/duke3d-palette
[dependencies-image]: https://img.shields.io/david/nitro404/duke3d-palette.svg

[install-size-url]: https://packagephobia.now.sh/result?p=duke3d-palette
[install-size-image]: https://badgen.net/packagephobia/install/duke3d-palette

[contributors-url]: https://github.com/nitro404/duke3d-palette/graphs/contributors
[contributors-image]: https://img.shields.io/github/contributors/nitro404/duke3d-palette.svg

[pull-requests-url]: https://github.com/nitro404/duke3d-palette/pulls
[pull-requests-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg