ruby-progressbar's Introduction

Ruby/ProgressBar

The ultimate text progress bar library for Ruby! It'll SMASH YOU OVER THE HEAD with a PURE RUSH of progress bar excitement!

Don't miss out on what all the kids are talking about! If you want everyone to know that your gem or app can survive in the cage then YOU WANT RUBY-PROGRESSBAR!

It's Better Than The Other 186,312 Progress Bar Libraries Because

It has stood the test of time (2008-today)
Full test suite
ZERO dependencies
Used by tons of other open source projects (which means we find out about bugs quickly)
It's pretty freakin' sweet
And most importantly... our awesome contributors

Basic Usage

Creation

It's simple to get started:

progressbar = ProgressBar.create

Creates a basic progress bar beginning at 0, a maximum capacity of 100 and tells it to start.

Progress: |                                                                       |

Marking Progress

Every call to #increment will advance the bar by 1. Therefore:

50.times { progressbar.increment }

Would output an advancing line which would end up here:

Progress: |===================================                                    |

Animation

Full Reference

There's gotten to be too much awesome to pack into one page. Visit the wiki for the full documentation.

Issues

If you have problems, please create a Github issue.

Credits

ruby-progressbar is maintained by The Kompanee, Ltd.

The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.

License

ruby-progressbar 1.0 is Copyright © 2011-2021 The Kompanee. It is free software, and may be redistributed under the terms specified in the LICENSE file. ruby-progressbar 0.9.0 is Copyright © 2008 Satoru Takabayashi

ruby-progressbar's People