warning-symbol/README.md

Cross-platform warning symbol.

# warning-symbol [![NPM version](https://badge.fury.io/js/warning-symbol.svg)](http://badge.fury.io/js/warning-symbol)

> Cross-platform warning symbol.

## Install

Install with [npm](https://www.npmjs.com/)

```sh
$ npm i warning-symbol --save
```

## Usage

```js
var warning = require('warning-symbol');
// if windows => '‼' else '⚠'
```

## Related projects

* [success-symbol](https://github.com/jonschlinkert/success-symbol)
* [warning-symbol](https://github.com/jonschlinkert/warning-symbol)
* [error-symbol](https://github.com/jonschlinkert/error-symbol)
* [info-symbol](https://github.com/jonschlinkert/info-symbol)

## Running tests

Install dev dependencies:

```sh
$ npm i -d && npm test
```

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/warning-symbol/issues/new)

## Author

**Jon Schlinkert**

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2015 Jon Schlinkert
Released under the MIT license.

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on May 27, 2015._