minor documentation tweaks
diff --git a/README.md b/README.md
index fd22141..dc6018d 100644
--- a/README.md
+++ b/README.md
@@ -10,9 +10,7 @@
**Small simple memory model** – Malloc is not needed. The encode context is 136 bytes, decode context is 104 bytes and the description of decoded data item is 56 bytes. Stack use is light and there is no recursion. The caller supplies the memory to hold the encoded CBOR and encode/decode contexts so caller has full control of memory usage making it good for embedded implementations that have to run in small fixed memory.
-**Supports nearly all of RFC 7049** – Only minor, corner-case parts of RFC 7049 are not directly supported (canonicalization, decimal fractions, big floats). Decoding
-indefinite length strings but requires a string allocator (see documentation). Encoding indefinite length strings is not supported, but
-is also not necessary or preferred.
+**Supports nearly all of RFC 7049** – Only minor, corner-case parts of RFC 7049 are not directly supported (canonicalization, decimal fractions, big floats). Decoding indefinite length strings but requires a string allocator (see documentation). Encoding indefinite length strings is not supported, but is also not necessary or preferred.
**Extensible and General** – Provides a way to handle data types that are not directly supported.
@@ -27,8 +25,7 @@
This code in Laurence's GitHub has diverged some from the CAF source with some small simplifications and tidying up.
-From Nov 3, 2018, the interface and code are fairly stable. Large changes are not planned or expected, particularly in the interface. The test coverage
-is pretty good.
+From Nov 3, 2018, the interface and code are fairly stable. Large changes are not planned or expected, particularly in the interface. The test coverage is pretty good.
## Building
There is a simple makefile for the UNIX style command line binary that compiles everything to run the tests.
@@ -45,14 +42,13 @@
For most use cases you should just be able to add them to your project. Hopefully the easy portability of this implementation makes this work straight away, whatever your development environment is.
-The files ieee754.c and ieee754.h are support for half-precision floating point. The encoding side of the floating point functionality is about
-500 bytes. If it is never called because no floating point numbers are ever encoded, all 500 bytes will be dead stripped and not
+The files ieee754.c and ieee754.h are support for half-precision floating point. The encoding side of the floating point functionality is about 500 bytes. If it is never called because no floating point numbers are ever encoded, all 500 bytes will be dead stripped and not
impact code size. The decoding side is about 150 bytes of object code. It is never dead stripped because it directly referenced by
the core decoder, however it doesn't add very much to the size.
The test directory includes some tests that are nearly as portable as the main implementation. If your development environment
doesn't support UNIX style command line and make, you should be able to make a simple project and add the test files to it.
-Then just call run_tests() to invole them all.
+Then just call run_tests() to invoke them all.
## Changes from CAF Version
diff --git a/inc/UsefulBuf.h b/inc/UsefulBuf.h
index 9c44ef7..2b808dc 100644
--- a/inc/UsefulBuf.h
+++ b/inc/UsefulBuf.h
@@ -42,6 +42,8 @@
when who what, where, why
-------- ---- ---------------------------------------------------
+ 12/13/2018 llundblade Documentation improvements
+ 09/18/2018 llundblade Cleaner distinction between UsefulBuf and UsefulBufC
02/02/18 llundbla Full support for integers in and out; fix pointer alignment bug
Incompatible change: integers in/out are now in network byte order.
08/12/17 llundbla Added UsefulOutBuf_AtStart and UsefulBuf_Find
diff --git a/inc/qcbor.h b/inc/qcbor.h
index 5a824f7..7009e60 100644
--- a/inc/qcbor.h
+++ b/inc/qcbor.h
@@ -43,6 +43,7 @@
when who what, where, why
-------- ---- ---------------------------------------------------
+ 12/13/18 llundblade Documentatation improvements
11/29/18 llundblade Rework to simpler handling of tags and labels.
11/9/18 llundblade Error codes are now enums.
11/1/18 llundblade Floating support.