pointer-symbol/README.md

Cross-platform pointer symbols for prompts.

# pointer-symbol [![NPM version](https://img.shields.io/npm/v/pointer-symbol.svg?style=flat)](https://www.npmjs.com/package/pointer-symbol) [![NPM monthly downloads](https://img.shields.io/npm/dm/pointer-symbol.svg?style=flat)](https://npmjs.org/package/pointer-symbol) [![NPM total downloads](https://img.shields.io/npm/dt/pointer-symbol.svg?style=flat)](https://npmjs.org/package/pointer-symbol)

> Cross-platform pointer symbols for prompts.

## Install

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

```sh
$ npm install --save pointer-symbol
```

## Usage

If you have any rendering issues on your platform, please create an [issue or pull request](../../issues).

```js
var pointer = require('pointer-symbol');

console.log(pointer());
// cygwin, msys, win32 
// '>'

// linux
// '‣'

// everything else
// '❯'

console.log(pointer({small: true}));
// cygwin, msys, win32 
// '»'

// linux
// '‣'

// everything else
// '›'
```

## About

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

### Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh
$ npm install && npm test
```

### Author

**Jon Schlinkert**

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

### License

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 23, 2017._