changeset 41:86b259a3f272

misc: update documentation
author David Demelier <markand@malikania.fr>
date Wed, 24 Nov 2021 10:02:57 +0100
parents ad4abb4e5ff0
children b31f8a71c1bc
files CHANGES.md INSTALL.md README.md
diffstat 3 files changed, 38 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CHANGES.md	Wed Nov 24 10:02:57 2021 +0100
@@ -0,0 +1,20 @@
+libbase64 CHANGES
+=================
+
+libbase64 3.0.0 ????-??-??
+--------------------------
+
+- The `b64_decode` function no longer adds NUL terminator for better binary data
+  support.
+- Shared library and system-wide install support.
+
+libbase64 2.0.0 2021-06-07
+--------------------------
+
+- API has been simplified.
+- Binary data support.
+
+libbase64 1.0.0 2016-10-25
+--------------------------
+
+- Initial 1.0.0 release.
--- a/INSTALL.md	Tue Nov 23 17:07:02 2021 +0100
+++ b/INSTALL.md	Wed Nov 24 10:02:57 2021 +0100
@@ -9,4 +9,19 @@
 Installation
 ------------
 
+The module is small enough to be incorporated verbatim into your project, but it
+still possible to install it system wide.
+
+### System wide
+
+	$ make
+	# make install
+
+Linux, BSD shared libraries aren't part of POSIX so need an additional step:
+
+	$ make so
+	# make install-so
+
+### Embed
+
 Copy base64.h and base64.c to your project.
--- a/README.md	Tue Nov 23 17:07:02 2021 +0100
+++ b/README.md	Wed Nov 24 10:02:57 2021 +0100
@@ -33,12 +33,10 @@
 
 	size = b64_decode("ABx=", -1, decoded, sizeof (decoded));
 
-Note: even with binary data the function `b64_decode` still append a NUL
-terminator. Use the return code from the function to get the size binary data.
+Note: don't discard return value, in contrast to `b64_encode` the output buffer
+      isn't NUL terminated as it may contain binary data.
 
 Documentation
 -------------
 
-See the libbase64(3) manual page.
-
-	man ./libbase64.3
+See the `libbase64(3)` manual page.