Added examples

README.md

@@ -1,5 +1,10 @@
 # ESP32-targz
 
+
+![](ESP32-targz.png)
+
+
+
 This library is a wrapper for the following two great libraries:
 
   - uzlib https://github.com/pfalcon/uzlib
@@ -10,17 +15,61 @@ Decompression support for .tar and .gz files
 This is a work in progress
 
 
+
+Extract content from `.gz` file
+-------------------------------
+
+```C
+
+  // mount spiffs (or any other filesystem)
+  SPIFFS.begin(true);
+
+  // expand one file
+  gzExpander(SPIFFS, "/index_html.gz", SPIFFS, "/index.html");
+
+  // expand another file
+  gzExpander(SPIFFS, "/tbz.gz", SPIFFS, "/tbz.jpg");
+
+
+```
+
+
+Expand contents from `.tar` file to `/tmp` folder
+-------------------------------------------------
+
 ```C
-#include <ESP32-targz.h>
 
-void setup() {
+  // mount spiffs (or any other filesystem)
   SPIFFS.begin(true);
-  uzFileExpander(SPIFFS, "/menu.tar.gz", SPIFFS, "/menu.tar");
-  untarFile(SPIFFS, "/menu.tar");
-}
 
-void loop() {
+  tarExpander(SPIFFS, "/tobozo.tar", SPIFFS, "/tmp");
+
+
+```
+
+
+
+Expand contents from `.tar.gz`  to `/tmp` folder
+------------------------------------------------
+
+```C
+
+  // mount spiffs (or any other filesystem)
+  SPIFFS.begin(true);
+
+  tarGzExpander(SPIFFS, "/tbz.tar.gz", SPIFFS, "/tmp");
+
+```
+
+
+Flash the ESP with contents from `.gz` file
+-------------------------------------------
+
+```C
+  // mount spiffs (or any other filesystem)
+    SPIFFS.begin(true);
+
+  gzUpdater(SPIFFS, "/menu_bin.gz");
 
-}
 
 ```

examples/Unpack_gz_file/Unpack_gz_file.ino

@@ -0,0 +1,20 @@
+#include <ESP32-targz.h>
+
+void setup() {
+
+  Serial.begin( 115200 );
+
+  SPIFFS.begin( true );
+
+  // extract content from gz file
+  gzExpander(SPIFFS, "/index_html.gz", SPIFFS, "/index.html");
+
+  gzExpander(SPIFFS, "/tbz.gz", SPIFFS, "/tbz.jpg");
+
+  tarGzListDir( SPIFFS, "/");
+
+}
+
+void loop() {
+
+}

examples/Unpack_tar_file/Unpack_tar_file.ino

@@ -0,0 +1,18 @@
+#include <ESP32-targz.h>
+
+void setup() {
+
+  Serial.begin( 115200 );
+
+  SPIFFS.begin(true);
+
+  // expand tar contents to /tmp folder
+  tarExpander(SPIFFS, "/tobozo.tar", SPIFFS, "/tmp");
+
+  tarGzListDir( SPIFFS, "/tmp");
+
+}
+
+void loop() {
+
+}

examples/Unpack_targz_file/Unpack_targz_file.ino

@@ -0,0 +1,18 @@
+#include <ESP32-targz.h>
+
+void setup() {
+
+  Serial.begin( 115200 );
+
+  SPIFFS.begin(true);
+
+  // direct .tar.gz to file expanding
+  tarGzExpander(SPIFFS, "/tbz.tar.gz", SPIFFS, "/tmp");
+
+  tarGzListDir( SPIFFS, "/tmp");
+
+}
+
+void loop() {
+
+}

examples/Update_from_gz/Update_from_gz.ino

@@ -0,0 +1,24 @@
+#include <ESP32-targz.h>
+
+#define BUTTON_PIN 32
+
+void setup() {
+
+  Serial.begin( 115200 );
+
+  pinMode( BUTTON_PIN, INPUT_PULLUP );
+
+}
+
+void loop() {
+
+  if( digitalRead( BUTTON_PIN ) == LOW ) {
+
+    SPIFFS.begin(true);
+
+    // flash the ESP with gz's contents (gzip the bin yourself and use the spiffs uploader)
+    gzUpdater(SPIFFS, "/menu_bin.gz");
+
+  }
+
+}