UNPKG

759 BMarkdownView Raw
1# io-spin
2
3[![NPM version](https://img.shields.io/npm/v/io-spin.svg)](https://www.npmjs.com/package/io-spin)
4[![NPM download](https://img.shields.io/npm/dm/io-spin.svg)](https://www.npmjs.com/package/io-spin)
5[![Build Status: Linux](https://travis-ci.org/egoist/io-spin.svg?branch=master)](https://travis-ci.org/egoist/io-spin)
6
7Little terminal spinner lib for Node.js and io.js
8
9## Installation
10
11```bash
12$ npm install io-spin
13```
14
15## Example
16
17```javascript
18var Spin = require('io-spin')
19var spin = new Spin()
20// Spin(type, placeholder)
21
22spin.start()
23// call spin.stop() to stop spinner
24```
25
26## GIF (original from tj/go-spin)
27
28![gif](https://raw.githubusercontent.com/tj/go-spin/master/go-spin.gif)
29
30## License
31
32MIT © [EGOIST](https://github.com/egoist)