Permalink
Browse files

Documentation update

  • Loading branch information...
creaktive committed Oct 29, 2013
1 parent d63ba92 commit 59acdd4dd04216d0f7bbc18dcc880c4a7cc18068
Showing with 26 additions and 6 deletions.
  1. +1 −0 Build.PL
  2. +1 −0 META.json
  3. +1 −0 META.yml
  4. +7 −5 README
  5. +6 −0 README.md
  6. +1 −1 perlcritic.rc
  7. +9 −0 rainbarf
View
@@ -25,6 +25,7 @@ my $build = Module::Build->new(
'Clemens Hammacher <hammacher@cs.uni-saarland.de>', 'Clemens Hammacher <hammacher@cs.uni-saarland.de>',
'Henrik Hodne <henrik@hodne.io>', 'Henrik Hodne <henrik@hodne.io>',
'Joe Hassick <joe.hassick@gmail.com>', 'Joe Hassick <joe.hassick@gmail.com>',
'Josh Matthews <josh@jmatthews.us>',
'Sergey Romanov <complefor@rambler.ru>', 'Sergey Romanov <complefor@rambler.ru>',
'Tom Cammann <tom.cammann@vmci.net>', 'Tom Cammann <tom.cammann@vmci.net>',
'Tuomas Jormola <tj@solitudo.net>', 'Tuomas Jormola <tj@solitudo.net>',
View
@@ -58,6 +58,7 @@
"Clemens Hammacher <hammacher@cs.uni-saarland.de>", "Clemens Hammacher <hammacher@cs.uni-saarland.de>",
"Henrik Hodne <henrik@hodne.io>", "Henrik Hodne <henrik@hodne.io>",
"Joe Hassick <joe.hassick@gmail.com>", "Joe Hassick <joe.hassick@gmail.com>",
"Josh Matthews <josh@jmatthews.us>",
"Sergey Romanov <complefor@rambler.ru>", "Sergey Romanov <complefor@rambler.ru>",
"Tom Cammann <tom.cammann@vmci.net>", "Tom Cammann <tom.cammann@vmci.net>",
"Tuomas Jormola <tj@solitudo.net>" "Tuomas Jormola <tj@solitudo.net>"
View
@@ -35,6 +35,7 @@ x_contributors:
- 'Clemens Hammacher <hammacher@cs.uni-saarland.de>' - 'Clemens Hammacher <hammacher@cs.uni-saarland.de>'
- 'Henrik Hodne <henrik@hodne.io>' - 'Henrik Hodne <henrik@hodne.io>'
- 'Joe Hassick <joe.hassick@gmail.com>' - 'Joe Hassick <joe.hassick@gmail.com>'
- 'Josh Matthews <josh@jmatthews.us>'
- 'Sergey Romanov <complefor@rambler.ru>' - 'Sergey Romanov <complefor@rambler.ru>'
- 'Tom Cammann <tom.cammann@vmci.net>' - 'Tom Cammann <tom.cammann@vmci.net>'
- 'Tuomas Jormola <tj@solitudo.net>' - 'Tuomas Jormola <tj@solitudo.net>'
View
12 README
@@ -83,14 +83,14 @@ OPTIONS
This. This.
"--[no]battery" "--[no]battery"
Display the battery charge indicator. Display the battery charge indicator. Enabled by default.
"--[no]remaining" "--[no]remaining"
Display the time remaining until the battery is fully charged/empty. Display the time remaining until the battery is fully charged/empty.
See "CAVEAT". See "CAVEAT". Disabled by default.
"--[no]bolt" "--[no]bolt"
Display even fancier battery indicator. Display even fancier battery indicator. Disabled by default.
"--[no]bright" "--[no]bright"
Tricky one. Disabled by default. See "CAVEAT". Tricky one. Disabled by default. See "CAVEAT".
@@ -109,11 +109,11 @@ OPTIONS
Use load average <https://en.wikipedia.org/wiki/Load_(computing)> Use load average <https://en.wikipedia.org/wiki/Load_(computing)>
metric instead of CPU utilization. You might want to set the "--max" metric instead of CPU utilization. You might want to set the "--max"
threshold since this is an absolute value and has varying ranges on threshold since this is an absolute value and has varying ranges on
different systems. different systems. Disabled by default.
"--[no]swap" "--[no]swap"
Display the swap usage. Used swap amount is added to the total 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" "--max NUMBER"
Maximum "loadavg" you expect before rescaling the chart. Default is Maximum "loadavg" you expect before rescaling the chart. Default is
@@ -221,6 +221,8 @@ CONTRIBUTORS
* Joe Hassick <https://github.com/jh3> * Joe Hassick <https://github.com/jh3>
* Josh Matthews <https://github.com/jmatth>
* Sergey Romanov <https://github.com/sergeyromanov> * Sergey Romanov <https://github.com/sergeyromanov>
* Tom Cammann <https://github.com/takac> * Tom Cammann <https://github.com/takac>
View
@@ -101,14 +101,17 @@ Configuration file can be specified via `RAINBARF` environment variable:
- `--[no]battery` - `--[no]battery`
Display the battery charge indicator. Display the battery charge indicator.
Enabled by default.
- `--[no]remaining` - `--[no]remaining`
Display the time remaining until the battery is fully charged/empty. See ["CAVEAT"](#CAVEAT). Display the time remaining until the battery is fully charged/empty. See ["CAVEAT"](#CAVEAT).
Disabled by default.
- `--[no]bolt` - `--[no]bolt`
Display even fancier battery indicator `⚡`. Display even fancier battery indicator `⚡`.
Disabled by default.
- `--[no]bright` - `--[no]bright`
@@ -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. 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. 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` - `--[no]swap`
Display the swap usage. Display the swap usage.
Used swap amount is added to the total amount, but the free swap amount is not! Used swap amount is added to the total amount, but the free swap amount is not!
Disabled by default.
- `--max NUMBER` - `--max NUMBER`
@@ -219,6 +224,7 @@ Stanislaw Pusep <stas@sysd.org>
- [Clemens Hammacher](https://github.com/hammacher) - [Clemens Hammacher](https://github.com/hammacher)
- [Henrik Hodne](https://github.com/henrikhodne) - [Henrik Hodne](https://github.com/henrikhodne)
- [Joe Hassick](https://github.com/jh3) - [Joe Hassick](https://github.com/jh3)
- [Josh Matthews](https://github.com/jmatth)
- [Sergey Romanov](https://github.com/sergeyromanov) - [Sergey Romanov](https://github.com/sergeyromanov)
- [Tom Cammann](https://github.com/takac) - [Tom Cammann](https://github.com/takac)
- [Tuomas Jormola](https://github.com/tjormola) - [Tuomas Jormola](https://github.com/tjormola)
View
@@ -10,4 +10,4 @@ equivalent_modules = common::sense
severity = gentle severity = gentle
[Subroutines::ProhibitExcessComplexity] [Subroutines::ProhibitExcessComplexity]
max_mccabe = 30 max_mccabe = 35
View
@@ -570,14 +570,17 @@ This.
=item C<--[no]battery> =item C<--[no]battery>
Display the battery charge indicator. Display the battery charge indicator.
Enabled by default.
=item C<--[no]remaining> =item C<--[no]remaining>
Display the time remaining until the battery is fully charged/empty. See L</CAVEAT>. Display the time remaining until the battery is fully charged/empty. See L</CAVEAT>.
Disabled by default.
=item C<--[no]bolt> =item C<--[no]bolt>
Display even fancier battery indicator. Display even fancier battery indicator.
Disabled by default.
=item C<--[no]bright> =item C<--[no]bright>
@@ -600,11 +603,13 @@ Force chart background color.
Use L<load average|https://en.wikipedia.org/wiki/Load_(computing)> metric instead of CPU utilization. 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. 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> =item C<--[no]swap>
Display the swap usage. Display the swap usage.
Used swap amount is added to the total amount, but the free swap amount is not! Used swap amount is added to the total amount, but the free swap amount is not!
Disabled by default.
=item C<--max NUMBER> =item C<--max NUMBER>
@@ -733,6 +738,10 @@ L<Joe Hassick|https://github.com/jh3>
=item * =item *
L<Josh Matthews|https://github.com/jmatth>
=item *
L<Sergey Romanov|https://github.com/sergeyromanov> L<Sergey Romanov|https://github.com/sergeyromanov>
=item * =item *

0 comments on commit 59acdd4

Please sign in to comment.