Bump version, write README and update Changes

diff --git a/Changes b/Changes
index 415393016a1ef2b6c587b840f61c9a3ddee96584..f9d2593c8c66862fc98358a4ec22b3942e5d23c8 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,4 +1,8 @@
 Revision history for Perl extension Convert::Base91.
 
-0.001 2017-12-16T20:12
+0.001001 2017-12-22T19:21+03:00
+ - Fix compilation on perls with -Dusemultiplicity
+ - Write README
+
+0.001 2017-12-16T20:12+03:00
  - Initial release

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

diff --git a/lib/Convert/Base91.pm b/lib/Convert/Base91.pm
index 075b75db4aac853d4cb8447e7424c0201001cdb3..2acfc0509fcb0506e1b50d50f276eca9514e57d4 100644 (file)
--- a/lib/Convert/Base91.pm
+++ b/lib/Convert/Base91.pm
@@ -8,7 +8,7 @@ use parent qw/Exporter/;
 our @EXPORT_OK = qw/encode_base91 decode_base91/;
 our @EXPORT = ();
 
-our $VERSION = '0.001';
+our $VERSION = '0.001001';
 
 require XSLoader;
 XSLoader::load('Convert::Base91', $VERSION);