aboutsummaryrefslogtreecommitdiff
path: root/node_modules/cli-spinners/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/cli-spinners/readme.md')
-rw-r--r--node_modules/cli-spinners/readme.md55
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 [![Build Status](https://travis-ci.org/sindresorhus/cli-spinners.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-spinners)
+
+> 60+ spinners for use in the terminal
+
+![](screenshot.gif)
+
+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.png)](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)