aboutsummaryrefslogtreecommitdiff
path: root/README.rakudoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.rakudoc')
-rw-r--r--README.rakudoc42
1 files changed, 42 insertions, 0 deletions
diff --git a/README.rakudoc b/README.rakudoc
new file mode 100644
index 0000000..b54ccc5
--- /dev/null
+++ b/README.rakudoc
@@ -0,0 +1,42 @@
+=begin pod
+
+=NAME Log::Colored
+=VERSION 0.0.0
+=AUTHOR Patrick Spek <p.spek@tyil.nl>
+
+=head1 Description
+
+A Log implementation with colored output. This is based upon C<Log::Simple>,
+with some changes to no longer show the level name in the log messages, and
+instead use colors to denote severity.
+
+=head1 Installation
+
+Install this module through L<zef|https://github.com/ugexe/zef>:
+
+=begin code :lang<sh>
+zef install Log::Colored
+=end code
+
+=head1 Documentation
+
+Documentation is written as L<Pod6|https://docs.raku.org/language/pod>
+documents, and can be read with the
+L<C<p6doc>|https://modules.raku.org/dist/p6doc:github:perl6> module.
+
+=begin input
+p6doc Log::Colored
+=end input
+
+At your option, you can also use prettier readers, such as
+L<C<App::Rakuman>|https://modules.raku.org/dist/App::Rakuman:cpan:TYIL>.
+
+=begin input
+rakuman Log::Colored
+=end input
+
+=head1 License
+
+This module is distributed under the terms of the LGPL-3.0-only.
+
+=end pod