From 59acdd4dd04216d0f7bbc18dcc880c4a7cc18068 Mon Sep 17 00:00:00 2001 From: Stanislaw Pusep Date: Tue, 29 Oct 2013 13:11:36 +0100 Subject: [PATCH] Documentation update --- Build.PL | 1 + META.json | 1 + META.yml | 1 + README | 12 +++++++----- README.md | 6 ++++++ perlcritic.rc | 2 +- rainbarf | 9 +++++++++ 7 files changed, 26 insertions(+), 6 deletions(-) diff --git a/Build.PL b/Build.PL index 7e6cd27..3519f76 100644 --- a/Build.PL +++ b/Build.PL @@ -25,6 +25,7 @@ my $build = Module::Build->new( 'Clemens Hammacher ', 'Henrik Hodne ', 'Joe Hassick ', + 'Josh Matthews ', 'Sergey Romanov ', 'Tom Cammann ', 'Tuomas Jormola ', diff --git a/META.json b/META.json index 7000e40..b509ed8 100644 --- a/META.json +++ b/META.json @@ -58,6 +58,7 @@ "Clemens Hammacher ", "Henrik Hodne ", "Joe Hassick ", + "Josh Matthews ", "Sergey Romanov ", "Tom Cammann ", "Tuomas Jormola " diff --git a/META.yml b/META.yml index d1d4b21..d25c996 100644 --- a/META.yml +++ b/META.yml @@ -35,6 +35,7 @@ x_contributors: - 'Clemens Hammacher ' - 'Henrik Hodne ' - 'Joe Hassick ' + - 'Josh Matthews ' - 'Sergey Romanov ' - 'Tom Cammann ' - 'Tuomas Jormola ' diff --git a/README b/README index 09a2cb6..c63f5c3 100644 --- a/README +++ b/README @@ -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". @@ -109,11 +109,11 @@ OPTIONS Use load average 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 @@ -221,6 +221,8 @@ CONTRIBUTORS * Joe Hassick + * Josh Matthews + * Sergey Romanov * Tom Cammann diff --git a/README.md b/README.md index 7ca5047..e732772 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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` @@ -219,6 +224,7 @@ Stanislaw Pusep - [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) diff --git a/perlcritic.rc b/perlcritic.rc index f33f37f..3545ff6 100644 --- a/perlcritic.rc +++ b/perlcritic.rc @@ -10,4 +10,4 @@ equivalent_modules = common::sense severity = gentle [Subroutines::ProhibitExcessComplexity] -max_mccabe = 30 +max_mccabe = 35 diff --git a/rainbarf b/rainbarf index e29afec..7665883 100755 --- a/rainbarf +++ b/rainbarf @@ -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. +Disabled by default. =item C<--[no]bolt> Display even fancier battery indicator. +Disabled by default. =item C<--[no]bright> @@ -600,11 +603,13 @@ Force chart background color. Use L 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> @@ -733,6 +738,10 @@ L =item * +L + +=item * + L =item *