Bump version, write README and update Changes

[convert-base91.git] / README

diff --git a/README b/README
index 0bb0c9a4859371f3b2d0b241c23d5051c4391798..ba5a5bdcd901466c758ea11ff577244914c9bc96 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,13 @@
-Convert-Base91 version 0.001
-============================
+Convert-Base91 version 0.001001
+===============================
 
-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,14 +20,11 @@ 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
 
 This library is free software; you can redistribute it and/or modify