README.md in whirly-0.2.1 vs README.md in whirly-0.2.2
- old
+ new
@@ -1,10 +1,13 @@
# Whirly 😀 [![[version]](https://badge.fury.io/rb/whirly.svg)](http://badge.fury.io/rb/whirly) [![[travis]](https://travis-ci.org/janlelis/whirly.png)](https://travis-ci.org/janlelis/whirly)
-A simple, colorful and customizable terminal spinner library for Ruby. It comes with 17 custom spinners and also includes those from the [cli-spinners](https://github.com/sindresorhus/cli-spinners) project.
+A simple, colorful and customizable terminal spinner library for Ruby. It comes with 18 custom spinners and also includes those from the [cli-spinners](https://github.com/sindresorhus/cli-spinners) project.
## Demonstration
+
+
+
### Bundled Whirly Spinners
[Play on asciinema](https://asciinema.org/a/88198?size=big)
### Bundled Spinners from CLI Spinners
@@ -102,14 +105,14 @@
### Main Options
#### `spinner:`
-You have multiple ways of telling *Whirly* which spinner should be used. You can pass the following to the `spinner:` option:
-
*Default:* `"whirly"`
+You have multiple ways of telling *Whirly* which spinner should be used. You can pass the following to the `spinner:` option:
+
- The name of a bundled spinner
- An array of spinner frames to use
- A proc which generates the frames dynamically
- A full spinner hash object ([explained below](https://github.com/janlelis/whirly#full-spinner-hash-format))
@@ -135,11 +138,11 @@
#### `ansi_escape_mode:`
*Default:* `"restore"`
-Can be set to `"line"` to use an different way of producing ANSI escape sequences (experimental)
+Can be set to `"line"` to use an different way of producing ANSI escape sequences necessary (experimental).
#### `append_newline:`
*Default:* `true`
@@ -165,11 +168,11 @@
#### `mode:`
*Default:* `"linear"`
-Instructs Whirly to play the frames in a different order. Possible values: `"linear"`, `"reverse"`, `"swing"`, and `"random"`. See spinner format section for more details.
+Instructs Whirly to play the frames in a different order. Possible values: `"linear"`, `"reverse"`, `"swing"`, and `"random"`. See [spinner format section](https://github.com/janlelis/whirly#mode-1) for more details.
#### `non_tty:`
*Default:* `false`
@@ -181,10 +184,10 @@
You can set this to `"below"` to let Whirly appear one line below its normal position.
#### `remove_after_stop:`
-*Default:* `"false"`
+*Default:* `false`
Causes the last frame to be removed after the spinner stopped.
#### `stop:`