Fix API and Update Readme

Author: siara-cc

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2019 Siara Logics (cc)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,2 +1,69 @@
-# Shox96_Arduino_Progmem_lib
-Store and retrieve compressed data using Progmem for Arduino Uno and upwards
+# Compression and decompression Library for use with Arduino Flash Memory (PROGMEM)
+
+[Shox96](https://github.com/siara-cc/Shox96) is a technique used for compressing and decompressing short strings. This library allows storing of compressed text strings in Arduino Program Memory and provides API to retrieve each string individually using index.
+
+Shox96 can achieve upto 60% compression depending on the composition of text.  This can be especially useful in constrained environments like Arduino Uno where only 32kb of Flash memory is available.
+
+## Applications
+
+- Displaying descriptive error or warning messages
+- Storing text file content (such as html)
+- Transferring compressed content over low speed networks
+
+## Usage
+
+First, the strings that need to compressed should to be listed in a file (usually with .txt extension).
+
+Download [Shox96](https://github.com/siara-cc/Shox96) and compile it using instructions provided in the repository. Then create compressed PROGMEM header using following command:
+
+```
+./shox96 g <text_file> <output_header_name>
+```
+
+or
+
+```
+./shox96 G <text_file> <output_header_name>
+```
+
+The command with capital G provides more compression taking into account repeating texts across the file.
+
+For example, if we use the file `proverbs.txt` given in the repository and the command `./shox96 g proverbs.txt proverbs`, a file by name `proverbs.h` will be generated.
+
+This file can be copied alongside any `.ino` file and included.  Then the `shox96_0_2_pgm_decompress()` API from `shox96_progmem_0_2.h` in this library can be called to uncompress the strings.
+
+Please try the examples provided along with this library to see how it works.
+
+## Compatibility
+
+This library can be used with Arduino Duemilanove, Uno upwards.  It is useful only if saving by compressing text content is over 3000 bytes since the decompressor takes as much space.
+
+## Limitations
+
+- Only text data (ASCII 32 to 126, 13, 10, 9) can be compressed using Shox96
+- The capital G parameter requires more memory allocated for decompression. Please see `Html` example
+- It is useful only if saving by compressing text content is over 3000 bytes since the decompressor takes as much space.
+
+## Examples and screenshots
+
+### Html
+
+This example demonstrates de-compression of Html content. Source of Html content is https://github.com/modularcode/modular-admin-html, which is released under MIT License.
+
+![](ss_html.png?raw=true)
+
+### Error Messages
+
+This example demonstrates de-compression of Error messages. Source: `include/errno.h` of GCC.
+
+![](ss_err_msgs.png?raw=true)
+
+### Proverbs
+
+This example demonstrates de-compression of compressed proverbs. Source: https://en.wikipedia.org/wiki/List_of_proverbial_phrases.
+
+![](ss_proverbs.png?raw=true)
+
+## Issues
+
+If you face any problems, please create issue on GitHub.

examples/Compress_Short_Strings/Compress_Short_Strings.ino

@@ -16,12 +16,13 @@
   https://github.com/siara-cc/Shox96/blob/master/Shox96_Article_0_2_0.pdf?raw=true
 
   Other projects using Shox96:
+  Compression library for Arduino - https://github.com/siara-cc/Shox96_Arduino_lib
   As SQLite loadable extension - https://github.com/siara-cc/Shox96_Sqlite_UDF
   Sqlite3 Library for ESP32 - https://github.com/siara-cc/esp32_arduino_sqlite3_lib
   Sqlite3 Library for ESP8266 - https://github.com/siara-cc/esp_arduino_sqlite3_lib
   Sqlite3 Library for ESP-IDF - https://github.com/siara-cc/esp32-idf-sqlite3
 */
-#include "shox96_0_2.h"
+#include "shox96_progmem_0_2.h"
 #include "errno.h"
 
 void setup() {
@@ -32,7 +33,7 @@ void setup() {
   char out[100];
 
   for (int i=0; i < errno0_2_line_count; i++) {
-     int len = shox96_0_2_decompress(errno0_2, i, out, 0);
+     int len = shox96_0_2_pgm_decompress(errno0_2, i, out, 0);
      out[len] = 0;
      Serial.write(out);
      Serial.write("\n");

examples/Error_Messages/Error_Messages.ino

@@ -14,12 +14,13 @@
   https://github.com/siara-cc/Shox96/blob/master/Shox96_Article_0_2_0.pdf?raw=true
 
   Other projects using Shox96:
+  Compression library for Arduino - https://github.com/siara-cc/Shox96_Arduino_lib
   As SQLite loadable extension - https://github.com/siara-cc/Shox96_Sqlite_UDF
   Sqlite3 Library for ESP32 - https://github.com/siara-cc/esp32_arduino_sqlite3_lib
   Sqlite3 Library for ESP8266 - https://github.com/siara-cc/esp_arduino_sqlite3_lib
   Sqlite3 Library for ESP-IDF - https://github.com/siara-cc/esp32-idf-sqlite3
 */
-#include "shox96_0_2.h"
+#include "shox96_progmem_0_2.h"
 #include "Html.h"
 
 void setup() {
@@ -34,7 +35,7 @@ void setup() {
   char out[1000];
 
   for (int i=0; i < html0_2_line_count; i++) {
-     int len = shox96_0_2_decompress(html0_2, i, out, 0);
+     int len = shox96_0_2_pgm_decompress(html0_2, i, out, 0);
      out[len] = 0;
      Serial.write(out);
      Serial.write("\n");

examples/Html/Html.ino

@@ -13,12 +13,13 @@
   https://github.com/siara-cc/Shox96/blob/master/Shox96_Article_0_2_0.pdf?raw=true
 
   Other projects using Shox96:
+  Compression library for Arduino - https://github.com/siara-cc/Shox96_Arduino_lib
   As SQLite loadable extension - https://github.com/siara-cc/Shox96_Sqlite_UDF
   Sqlite3 Library for ESP32 - https://github.com/siara-cc/esp32_arduino_sqlite3_lib
   Sqlite3 Library for ESP8266 - https://github.com/siara-cc/esp_arduino_sqlite3_lib
   Sqlite3 Library for ESP-IDF - https://github.com/siara-cc/esp32-idf-sqlite3
 */
-#include "shox96_0_2.h"
+#include "shox96_progmem_0_2.h"
 #include "Proverbs.h"
 
 void setup() {
@@ -52,15 +53,15 @@ void loop() {
       }
   }
 
-  if (ch == 1) {
+  if (ch == '1') {
     for (int i=0; i < Proverbs0_2_line_count; i++) {
-        int len = shox96_0_2_decompress(Proverbs0_2, i, out, 0);
+        int len = shox96_0_2_pgm_decompress(Proverbs0_2, i, out, 0);
         out[len] = 0;
         Serial.write(out);
         Serial.write("\n");
     }
-  } else if (ch == 2) {
-    int len = shox96_0_2_decompress(Proverbs0_2, random(0, Proverbs0_2_line_count - 1), out, 0);
+  } else if (ch == '2') {
+    int len = shox96_0_2_pgm_decompress(Proverbs0_2, random(0, Proverbs0_2_line_count - 1), out, 0);
     out[len] = 0;
     Serial.write(out);
     Serial.write("\n\n");

examples/Proverbs/Proverbs.ino

@@ -1,9 +1,9 @@
-name=Shox96
-version=0.2
+name=Shox96 Promem
+version=1.0
 author=Arundale Ramanathan
 maintainer=Arun <arun@siara.cc>
-sentence=Shox96 Compression library for Arduino UNO and up
-paragraph=Compress short strings and messages and save upto 60% space on RAM or PROGMEM
+sentence=Compress short strings and messages and save space on Flash (PROGMEM)
+paragraph=This library allows storing of compressed text strings in Arduino Program Memory and provides API to retrieve each string individually using index.
 category=Data Storage
-url=https://github.com/siara-cc/Shox96_Arduino_lib
+url=https://github.com/siara-cc/Shox96_Arduino_Progmem_lib
 architectures=*