From 07a6fd914009283bda7f1769be314724cc8538a2 Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Sat, 28 Oct 2023 11:48:19 -0700 Subject: [PATCH] initial commits --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a9a0d1..3206c83 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,14 @@ Package **hexadeca** implements **hexadecimal** _encoding_ and _decoding_, for the Go programming language. This is meant to be a better alternative to Go's built-in `"hex"` package. -Package **hexadeca** has functions for hexadecimal encoding and decoding with Go types: +Package **hexadeca** does _not_ impose any endianness for hexadecimal encoding. +The individual symbols are returned separately. For example: + +```go +b3, b2, b1, b0 := hexadeca.EncodeUint16UsingUpperCaseSymbols(u16) +``` + +Package **hexadeca** has functions for hexadecimal encoding and decoding for the Go types: * `byte` (i.e., `uint8`), * `uint16`, * `uint32`