pirate-flag

> A black flag bearing the figure of a skeleton

[![npm][npm]][npm-url]
[![travis][travis]][travis-url]
[![appveyor][appveyor]][appveyor-url]

🏴 Install

``bash
npm i -D pirate-flag
`

🏴 Usage

`javascript
var pirateFlag = require('pirate-flag');
pirateFlag(packageJson?: object, libInfo?: object, options?: object);
``

:black_circle: packageJson?: object

> name: string
>
version: string

:black_circle: options?: object

> comment: boolean
>
columns: number
>
lineChar: string
>
image: array

🏴 License

[Unlicense][license-url]

[npm]: https://img.shields.io/npm/v/pirate-flag.svg
[npm-url]: https://npmjs.com/package/pirate-flag

[npm]: https://img.shields.io/npm/v/pirate-flag.svg
[npm-url]: https://npmjs.com/package/pirate-flag

[travis]: https://travis-ci.org/adriancmiranda/pirate-flag.svg?branch=master
[travis-url]: https://travis-ci.org/adriancmiranda/pirate-flag

[appveyor]: https://ci.appveyor.com/api/projects/status/hucvow1n0t3q3le3/branch/master?svg=true
[appveyor-url]: https://ci.appveyor.com/project/adriancmiranda/pirate-flag/branch/master

[deps]: https://david-dm.org/adriancmiranda/pirate-flag.svg
[deps-url]: https://david-dm.org/adriancmiranda/pirate-flag

[depsci]: https://dependencyci.com/github/adriancmiranda/pirate-flag/badge
[depsci-url]: https://dependencyci.com/github/adriancmiranda/pirate-flag

[license-url]: https://github.com/adriancmiranda/pirate-flag/blob/master/LICENSE