diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-05-28 00:38:50 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-05-28 00:40:43 +0200 |
commit | 7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch) | |
tree | 6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/cli-spinners/readme.md | |
parent | 963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff) |
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/cli-spinners/readme.md')
-rw-r--r-- | node_modules/cli-spinners/readme.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/node_modules/cli-spinners/readme.md b/node_modules/cli-spinners/readme.md new file mode 100644 index 000000000..fe8703612 --- /dev/null +++ b/node_modules/cli-spinners/readme.md @@ -0,0 +1,55 @@ +# cli-spinners [](https://travis-ci.org/sindresorhus/cli-spinners) + +> 60+ spinners for use in the terminal + + + +The list of spinners is just a [JSON file](spinners.json) and can be used wherever. + +You probably want to use one of these spinners through the [`ora`](https://github.com/sindresorhus/ora) module. + + +## Install + +``` +$ npm install --save cli-spinners +``` + + +## Usage + +```js +const cliSpinners = require('cli-spinners'); + +console.log(cliSpinners.dots); +/* +{ + interval: 80, + frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'] +} +*/ +``` + + +## Preview + +The header GIF is outdated. Click below to see a preview of all the spinners. + +[](https://asciinema.org/a/95348?size=big) + + +## API + +Each spinner comes with a recommended `interval` and an array of `frames`. + +[See the spinners.](spinners.json) + + +## Related + +- [ora](https://github.com/sindresorhus/ora) - Elegant terminal spinner + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |