README.md in tqdm-0.2.0 vs README.md in tqdm-0.3.0
- old
+ new
@@ -1,20 +1,20 @@
# tqdm-ruby
-[](https://badge.fury.io/rb/tqdm)
+[](https://travis-ci.org/powerpak/tqdm-ruby) [](https://badge.fury.io/rb/tqdm)
tqdm-ruby allows you to add a progress indicator to your loops with minimal effort.
It is a port of the excellent [tqdm library][tqdm] for python. tqdm (read taqadum, تقدّم) means "progress" in Arabic.
-Calling `#tqdm` (or its readable but longer alias `#with_progress`) on any `Enumerable` returns an enhanced clone that animates a meter on `$stderr` during iteration.
+Calling `#tqdm` (or `#with_progress`) on any `Enumerable` returns an enhanced clone that animates a meter during iteration.
```ruby
require 'tqdm'
(0...1000).tqdm.each { |x| sleep 0.01 }
```
-The default output looks like this:
+The default output is sent to `$stderr` and looks like this:
![|####------| 492/1000 49% [elapsed: 00:05 left: 00:05, 88.81 iters/sec]](http://i.imgur.com/6y0t7XS.gif)
It works equally well from within irb, [pry](http://pryrepl.org/), and [iRuby notebooks](https://github.com/SciRuby/iruby) as seen here:
@@ -80,10 +80,10 @@
```
## TODO
1. Performance improvements
-2. Test/benchmark suite
+2. Add benchmark suite, expand test coverage
3. Add smoothing for speed estimates
4. Support unicode output (smooth blocks)
5. By default, resize to the apparent width of the output terminal
## Contributing