1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
Ruby/ProgressBar
================================================================================
<div align="center">
<a href="https://rubygems.org/gems/ruby-progressbar" alt="RubyGems Version">
<img src="https://img.shields.io/gem/v/ruby-progressbar.svg?style=flat-square&label=current-version" alt="RubyGems Version" />
</a>
<a href="https://rubygems.org/gems/ruby-progressbar" alt="RubyGems Rank Overall">
<img src="https://img.shields.io/gem/rt/ruby-progressbar.svg?style=flat-square&label=total-rank" alt="RubyGems Rank Overall" />
</a>
<a href="https://rubygems.org/gems/ruby-progressbar" alt="RubyGems Rank Daily">
<img src="https://img.shields.io/gem/rd/ruby-progressbar.svg?style=flat-square&label=daily-rank" alt="RubyGems Rank Daily" />
</a>
<a href="https://rubygems.org/gems/ruby-progressbar" alt="RubyGems Downloads">
<img src="https://img.shields.io/gem/dt/ruby-progressbar.svg?style=flat-square&label=total-downloads" alt="RubyGems Downloads" />
</a>
<a href="https://github.com/jfelchner/ruby-progressbar/actions?query=workflow%3ABuild" alt="Build Status">
<img src="https://img.shields.io/github/workflow/status/jfelchner/ruby-progressbar/Build?label=CI&style=flat-square&logo=github" alt="Build Status" />
</a>
<a href="#" alt="Maintainability">
<img src="https://img.shields.io/codeclimate/maintainability/jfelchner/ruby-progressbar?style=flat-square&label=grade" alt="Maintainability" />
</a>
</div>
<br>
<img src="https://kompanee-public-assets.s3.amazonaws.com/readmes/ruby-progressbar-cage.png" align="right" />
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**!
<br>
It's Better Than The Other 186,312 Progress Bar Libraries Because
--------------------------------------------------------------------------------
* It has [stood the test of time][history] (2008-today)
* Full test suite
* [_**ZERO**_ dependencies][gemspec]
* Used by [tons of other open source projects][dependencies] (which means we
find out about bugs quickly)
* It's pretty [freakin' sweet](https://www.youtube.com/watch?v=On3IoVhf_GM)
* And most importantly... our awesome [contributors][contributors]
Basic Usage
--------------------------------------------------------------------------------
### Creation
It's simple to get started:
```ruby
progressbar = ProgressBar.create
```
Creates a basic progress bar beginning at `0`, a maximum capacity of `100` and
tells it to start.
```text
Progress: | |
```
### Marking Progress
Every call to `#increment` will advance the bar by `1`. Therefore:
```ruby
50.times { progressbar.increment }
```
Would output an advancing line which would end up here:
```text
Progress: |=================================== |
```
### Animation
Full Reference
--------------------------------------------------------------------------------
There's gotten to be too much awesome to pack into one page. Visit the
[wiki][wiki] for the full documentation.
Issues
--------------------------------------------------------------------------------
If you have problems, please create a [Github issue][issues].
Credits
--------------------------------------------------------------------------------
![The Kompanee][kompanee-logo]
ruby-progressbar is maintained by [The Kompanee, Ltd.][kompanee-site]
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][satoru]
[contributors]: https://github.com/jfelchner/ruby-progressbar/graphs/contributors
[dependencies]: https://github.com/jfelchner/ruby-progressbar/network/dependents
[gemspec]: https://github.com/jfelchner/ruby-progressbar/blob/master/ruby-progressbar.gemspec
[history]: https://github.com/jfelchner/ruby-progressbar/wiki/History
[issues]: https://github.com/jfelchner/ruby-progressbar/issues
[kompanee-logo]: https://kompanee-public-assets.s3.amazonaws.com/readmes/kompanee-horizontal-black.png
[kompanee-site]: http://www.thekompanee.com
[satoru]: http://0xcc.net
[wiki]: https://github.com/jfelchner/ruby-progressbar/wiki
|
