Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# pointer-symbol [](https://www.npmjs.com/package/pointer-symbol) [](https://npmjs.org/package/pointer-symbol) [](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._