commit f2474bdee7fb17089d7a0b9b7c18017bbe2498e4
parent 770fa0386a4aeed657b400900f1dbaaf8374e88e
Author: Ajay R <ar324@protonmail.com>
Date: Mon, 16 May 2022 06:14:44 +0000
encoding::base32: update README
Diffstat:
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/encoding/base32/README b/encoding/base32/README
@@ -1,15 +1,15 @@
Implementation of the base32 encoding scheme as defined by RFC 4648.
-A stream-based encoding and decoding interface is available via [[new_encoder]]
-and [[new_decoder]], which transparently encode or decode bytes to or from
-base32 when reading from or writing to an underlying I/O handle.
+A stream-based encoding and decoding interface is available via [[newencoder]]
+and [[newdecoder]], which transparently encode or decode bytes to or from base32
+when writing to or reading from an underlying I/O handle.
-Convenience functions for decoding to or from byte slices or strings are also
-available; see [[encodeslice]], [[decodeslice]], [[encodestr]], and
-[[decodestr]]. These functions dynamically allocate their return value; use the
+Convenience functions for encoding to or decoding from a byte slice or a string
+are also available; see [[encodeslice]], [[decodeslice]], [[encodestr]], and
+[[decodestr]]. These functions dynamically allocate their return values; use the
stream interface if you require static allocation.
-Each function accepts the desired base64 encoding alphabet as its first
+Each function accepts the desired base32 encoding alphabet as its first
argument. [[std_encoding]] and [[hex_encoding]], as defined by the RFC, are
provided for your convenience, but you may create your own encoding using
[[encoding_init]].
