Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
creaktive committed Oct 29, 2013
1 parent d63ba92 commit 59acdd4
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 6 deletions.
1 change: 1 addition & 0 deletions Build.PL
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ my $build = Module::Build->new(
'Clemens Hammacher <[email protected]>',
'Henrik Hodne <[email protected]>',
'Joe Hassick <[email protected]>',
'Josh Matthews <[email protected]>',
'Sergey Romanov <[email protected]>',
'Tom Cammann <[email protected]>',
'Tuomas Jormola <[email protected]>',
Expand Down
1 change: 1 addition & 0 deletions META.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
"Clemens Hammacher <[email protected]>",
"Henrik Hodne <[email protected]>",
"Joe Hassick <[email protected]>",
"Josh Matthews <[email protected]>",
"Sergey Romanov <[email protected]>",
"Tom Cammann <[email protected]>",
"Tuomas Jormola <[email protected]>"
Expand Down
1 change: 1 addition & 0 deletions META.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ x_contributors:
- 'Clemens Hammacher <[email protected]>'
- 'Henrik Hodne <[email protected]>'
- 'Joe Hassick <[email protected]>'
- 'Josh Matthews <[email protected]>'
- 'Sergey Romanov <[email protected]>'
- 'Tom Cammann <[email protected]>'
- 'Tuomas Jormola <[email protected]>'
12 changes: 7 additions & 5 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,14 @@ OPTIONS
This.

"--[no]battery"
Display the battery charge indicator.
Display the battery charge indicator. Enabled by default.

"--[no]remaining"
Display the time remaining until the battery is fully charged/empty.
See "CAVEAT".
See "CAVEAT". Disabled by default.

"--[no]bolt"
Display even fancier battery indicator.
Display even fancier battery indicator. Disabled by default.

"--[no]bright"
Tricky one. Disabled by default. See "CAVEAT".
Expand All @@ -109,11 +109,11 @@ OPTIONS
Use load average <https://en.wikipedia.org/wiki/Load_(computing)>
metric instead of CPU utilization. You might want to set the "--max"
threshold since this is an absolute value and has varying ranges on
different systems.
different systems. Disabled by default.

"--[no]swap"
Display the swap usage. Used swap amount is added to the total
amount, but the free swap amount is not!
amount, but the free swap amount is not! Disabled by default.

"--max NUMBER"
Maximum "loadavg" you expect before rescaling the chart. Default is
Expand Down Expand Up @@ -221,6 +221,8 @@ CONTRIBUTORS

* Joe Hassick <https://github.com/jh3>

* Josh Matthews <https://github.com/jmatth>

* Sergey Romanov <https://github.com/sergeyromanov>

* Tom Cammann <https://github.com/takac>
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,17 @@ Configuration file can be specified via `RAINBARF` environment variable:
- `--[no]battery`

Display the battery charge indicator.
Enabled by default.

- `--[no]remaining`

Display the time remaining until the battery is fully charged/empty. See ["CAVEAT"](#CAVEAT).
Disabled by default.

- `--[no]bolt`

Display even fancier battery indicator ``.
Disabled by default.

- `--[no]bright`

Expand All @@ -131,11 +134,13 @@ Configuration file can be specified via `RAINBARF` environment variable:

Use [load average](https://en.wikipedia.org/wiki/Load\_(computing)) metric instead of CPU utilization.
You might want to set the `--max` threshold since this is an absolute value and has varying ranges on different systems.
Disabled by default.

- `--[no]swap`

Display the swap usage.
Used swap amount is added to the total amount, but the free swap amount is not!
Disabled by default.

- `--max NUMBER`

Expand Down Expand Up @@ -219,6 +224,7 @@ Stanislaw Pusep <[email protected]>
- [Clemens Hammacher](https://github.com/hammacher)
- [Henrik Hodne](https://github.com/henrikhodne)
- [Joe Hassick](https://github.com/jh3)
- [Josh Matthews](https://github.com/jmatth)
- [Sergey Romanov](https://github.com/sergeyromanov)
- [Tom Cammann](https://github.com/takac)
- [Tuomas Jormola](https://github.com/tjormola)
Expand Down
2 changes: 1 addition & 1 deletion perlcritic.rc
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ equivalent_modules = common::sense
severity = gentle

[Subroutines::ProhibitExcessComplexity]
max_mccabe = 30
max_mccabe = 35
9 changes: 9 additions & 0 deletions rainbarf
Original file line number Diff line number Diff line change
Expand Up @@ -570,14 +570,17 @@ This.
=item C<--[no]battery>
Display the battery charge indicator.
Enabled by default.
=item C<--[no]remaining>
Display the time remaining until the battery is fully charged/empty. See L</CAVEAT>.
Disabled by default.
=item C<--[no]bolt>
Display even fancier battery indicator.
Disabled by default.
=item C<--[no]bright>
Expand All @@ -600,11 +603,13 @@ Force chart background color.
Use L<load average|https://en.wikipedia.org/wiki/Load_(computing)> metric instead of CPU utilization.
You might want to set the C<--max> threshold since this is an absolute value and has varying ranges on different systems.
Disabled by default.
=item C<--[no]swap>
Display the swap usage.
Used swap amount is added to the total amount, but the free swap amount is not!
Disabled by default.
=item C<--max NUMBER>
Expand Down Expand Up @@ -733,6 +738,10 @@ L<Joe Hassick|https://github.com/jh3>
=item *
L<Josh Matthews|https://github.com/jmatth>
=item *
L<Sergey Romanov|https://github.com/sergeyromanov>
=item *
Expand Down

0 comments on commit 59acdd4

Please sign in to comment.