Docs: Add Auto Refresh to README

README.md

@@ -2,7 +2,8 @@
 
 [![Gem Version](https://img.shields.io/gem/v/fuubar.svg)](https://rubygems.org/gems/fuubar) ![Rubygems Rank Overall](https://img.shields.io/gem/rt/fuubar.svg) ![Rubygems Rank Daily](https://img.shields.io/gem/rd/fuubar.svg) ![Rubygems Downloads](https://img.shields.io/gem/dv/fuubar/stable.svg) [![Build Status](https://img.shields.io/travis/thekompanee/fuubar/master.svg)](http://travis-ci.org/thekompanee/fuubar) [![Code Climate](https://codeclimate.com/github/thekompanee/fuubar.svg)](https://codeclimate.com/github/thekompanee/fuubar)
 
-Fuubar is an instafailing [RSpec](http://github.com/rspec) formatter that uses a progress bar instead of a string of letters and dots as feedback.
+Fuubar is an instafailing [RSpec](http://github.com/rspec) formatter that uses
+a progress bar instead of a string of letters and dots as feedback.
 
 [![gif](http://i.imgur.com/GIiA53s.gif)](http://vimeo.com/16845253).
 
@@ -40,7 +41,8 @@ Then, when running rspec:
 rspec --format Fuubar --color spec
 ```
 
-Or, if you want to use Fuubar as your default formatter, simply put the options in your `.rspec` file:
+Or, if you want to use Fuubar as your default formatter, simply put the options
+in your `.rspec` file:
 
     --format Fuubar
     --color
@@ -70,9 +72,14 @@ Advanced Usage
 
 ### Customizing the Bar ###
 
-Fuubar exposes an RSpec configuration variable called `fuubar_progress_bar_options` which, when set will be passed directly to [ruby-progressbar](https://github.com/jfelchner/ruby-progressbar) which does all the heavy lifting.  Take a look at the documentation for details on all of the options you can pass in.
+Fuubar exposes an RSpec configuration variable called
+`fuubar_progress_bar_options` which, when set will be passed directly to
+[ruby-progressbar](https://github.com/jfelchner/ruby-progressbar) which does all
+the heavy lifting.  Take a look at the documentation for details on all of the
+options you can pass in.
 
-Let's say for example that you would like to change the format of the bar. You would do that like so:
+Let's say for example that you would like to change the format of the bar. You
+would do that like so:
 
 ```ruby
 # spec_helper.rb
@@ -86,23 +93,47 @@ would make it so that, when Fuubar is output, it would look something like:
 
     My Fuubar! <================================                  > 53.44% 00:12:31
 
+### Disabling Auto-Refresh ###
+
+By default Fuubar will automatically refresh the bar (and therefore the ETA)
+every second.  Unfortunately this doesn't play well with things like debuggers.
+When you're debugging, having a bar show up every second is undesireable.  Pry
+gives us hooks so that we can automatically disable the refresh when it's used.
+Unfortunately byebug does not and disabling the bar must be done manually like
+so:
+
+```ruby
+# spec_helper.rb
+
+RSpec.configure do |config|
+  config.fuubar_auto_refresh = false
+end
+```
+
 Issues
 --------------------------------
 
-If you have problems, please create a [Github issue](https://github.com/jeffkreeftmeijer/fuubar/issues).
+If you have problems, please create a [Github
+issue](https://github.com/jeffkreeftmeijer/fuubar/issues).
 
 Credits
 --------------------------------
 
 fuubar was created by [Jeff Kreeftmeijer](https://github.com/jeffkreeftmeijer)
-fuubar is maintained by [Jeff Kreeftmeijer](https://github.com/jeffkreeftmeijer) and [The Kompanee, Ltd.](http://www.thekompanee.com)
+fuubar is maintained by [Jeff Kreeftmeijer](https://github.com/jeffkreeftmeijer)
+and [The Kompanee, Ltd.](http://www.thekompanee.com)
 
 Contributing
 --------------------------------------------------------------------------------
 
-Found an issue? Have a great idea? Want to help? Great! Create an issue [issue](http://github.com/jeffkreeftmeijer/fuubar/issues) for it, or even better; fork the project and fix the problem yourself. Pull requests are always welcome. :)
+Found an issue? Have a great idea? Want to help? Great! Create an issue
+[issue](http://github.com/jeffkreeftmeijer/fuubar/issues) for it, or even
+better; fork the project and fix the problem yourself. Pull requests are always
+welcome. :)
 
 License
 --------------------------------
 
-fuubar is Copyright &copy; 2010-2016 Jeff Kreeftmeijer and Jeff Felchner. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+fuubar is Copyright &copy; 2010-2019 Jeff Kreeftmeijer and Jeff Felchner. It is
+free software, and may be redistributed under the terms specified in the LICENSE
+file.