Added updated docs and links.

Author: deftio

README.md

@@ -1,11 +1,14 @@
 [![License](https://img.shields.io/badge/License-BSD%202--Clause-blue.svg)](https://opensource.org/licenses/BSD-2-Clause)
 
-# Companders (a fixed point audio compression library)  
+# [Companders (a fixed point audio compression library)](https://deftio.github.io/companders/)  
 
-(c) 2001-2019  M. A. Chatterjee 
+(c) 2001-2023  M. A. Chatterjee 
 
-This document is a brief overview of this simple audio compression library for microcontrollers using A-Law (a type of compander).  This uses fixed-radix (integer only) math with
-a small introductory disucssion and use of associated DC-offset correction with an IIR fixed-radix filter.
+This document is a brief overview of this simple audio compression library for microcontrollers using A-Law (a type of compander).  This uses fixed-radix (integer only) math with a small introductory disucssion and use of associated DC-offset correction with an IIR fixed-radix filter.
+
+The code in this repo is suitable for small microcontrollers such as 8 bit and 16 bit families (arduino, 68hc, 8051 ) as well as on 32 bit familes such as ARM, RISC-V, etc.
+
+As this is a fixed point library (a type of integer math), floating point is not used or even emulated.  For more background on using fixed point (or fixed radix) math see this code library and documentation : [FR_Math](https://github.com/deftio/fr_math) 
 
 ## Welcome..
 
@@ -186,9 +189,11 @@ Finally,  it can be in some systems that we can't turn off the audio input sourc
 
 ## Versions
 
-* 1.0.1  3 Sep 2012  -- original release  
-* 1.0.2 15 Jul 2016  -- updated README.md to markdown format.  updated license to be OSI compliant.  no code changes. some minor doc updates. Thanks to John R Strohm giving me the nudge to update the docs here.  
+* 1.0.4 23 Jan 2023  -- updated docs 
 * 1.0.3 28 Jul 2019  -- updated docs, ver example
+* 1.0.2 15 Jul 2016  -- updated README.md to markdown format.  updated license to be OSI compliant.  no code changes. some minor doc updates. Thanks to John R Strohm giving me the nudge to update the docs here. 
+* 1.0.1  3 Sep 2012  -- original release in github  
+
 
 
 ## License

companders.h

@@ -1,7 +1,7 @@
 /**
  *	@companders.h - header definition file for embedded companding routines
  *		
- *	@copy Copyright (C) <2001-2012>  <M. A. Chatterjee>
+ *	@copy Copyright (C) <2001-2023>  <M. A. Chatterjee>
  *  @author M A Chatterjee <deftio [at] deftio [dot] com>
  *	@version 1.02 M. A. Chatterjee, cleaned up naming, license 
  *
@@ -10,7 +10,7 @@
  *
 LICENSE: 
 
-Copyright (c) 2001-2016, M. A. Chatterjee < deftio at deftio dot com >
+Copyright (c) 2001-2023, M. A. Chatterjee < deftio at deftio dot com >
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -45,7 +45,7 @@ extern "C"
 {
 #endif
 
-#define DIO_COMPANDERS_VER  (0x000010003)  //00 01 00 03 in hex
+#define DIO_COMPANDERS_VER  (0x000010004)  //00 01 00 04 in hex
 
 //"DIO" prefixes are to assist in prevent name collisions if global namespace is used.
 

dev/companders-todo.md

@@ -3,16 +3,16 @@
 (c)  2012 M. A. Chatterjee 
 
 ## Features
-	[ ] A-law encode
-	[ ] A-law decode
-	[ ] IIR fixed point filter for DC offset estimatation 
-	[ ] IIR fixed point filter for DC offset (power of 2)
+	[x] A-law encode
+	[x] A-law decode
+	[x] IIR fixed point filter for DC offset estimatation 
+	[x] IIR fixed point filter for DC offset (power of 2)
 			-- allows no divides  
-	[ ] example program
+	[x] example program
 
 
 ## TODO
-	[ ] build-test (travis etc)
+	[ ] build-test (travis /circle etc)
 	[ ] full test suite
 	[ ] u-law encode
 	[ ] u-law decode