X-Git-Url: http://git.ieval.ro/?a=blobdiff_plain;f=README;h=1c42239b990a71095b88a1f860e2065b3b1633fa;hb=refs%2Fheads%2Fmaster;hp=0bb0c9a4859371f3b2d0b241c23d5051c4391798;hpb=1a1c8cd6fc5912b018865b325eee4e7d69db4cd1;p=convert-base91.git

diff --git a/README b/README
index 0bb0c9a..1c42239 100644
--- a/README
+++ b/README
@@ -1,16 +1,13 @@
-Convert-Base91 version 0.001
+Convert-Base91 version 1.000
 ============================
 
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
+Base91 is a method for encoding binary data as printable ASCII
+characters. Every two base91 characters (16 bits) encode 13 or 14 bits
+of actual data, thus the overhead is between 14% and 23%, an
+improvement over base64's overhead of 33%.
 
-A README file is required for CPAN modules since CPAN extracts the
-README file from a module distribution so that people browsing the
-archive can use it get an idea of the modules uses. It is usually a
-good idea to provide version information here so that people can
-decide whether fixes for the module are worth downloading.
+This module provides a procedural interface for encoding/decoding
+whole strings and an OO interface for encoding/decoding in chunks.
 
 INSTALLATION
 
@@ -23,15 +20,12 @@ To install this module type the following:
 
 DEPENDENCIES
 
-This module requires these other modules and libraries:
-
-  blah blah blah
+This module requires no non-core modules and libraries.
+A C compiler is needed.
 
 COPYRIGHT AND LICENCE
 
-Put the correct copyright and licence information here.
-
-Copyright (C) 2017 by Marius Gavrilescu
+Copyright (C) 2017-2018 by Marius Gavrilescu
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself, either Perl version 5.26.1 or,