From 802b15432817341ea7219758bfb8495cf8771697 Mon Sep 17 00:00:00 2001
From: VOrishirne <vorishirne@gmail.com>
Date: Sat, 30 Oct 2021 09:37:22 +0530
Subject: [PATCH] Documented progress

---
 example/list-all.go |  2 +-
 go.mod              |  2 +-
 readme.md           | 47 ++++++++++++++++++++++++++-------------------
 3 files changed, 29 insertions(+), 22 deletions(-)

diff --git a/example/list-all.go b/example/list-all.go
index c72ddf9..bbf1b77 100644
--- a/example/list-all.go
+++ b/example/list-all.go
@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/watergist/file-engine/list"
+	"github.com/vorishirne/goreader/list"
 	"log"
 )
 
diff --git a/go.mod b/go.mod
index d2143ac..ae64086 100644
--- a/go.mod
+++ b/go.mod
@@ -1,4 +1,4 @@
-module github.com/watergist/file-engine
+module github.com/vorishirne/goreader
 
 go 1.16
 
diff --git a/readme.md b/readme.md
index ce749be..b54e363 100644
--- a/readme.md
+++ b/readme.md
@@ -1,25 +1,32 @@
-# file-engine
-module to deal with large or more files. 
-#### side-note: this module will not require frequent maintenance as it is quite close to the golang std library.
+# goreader
+A utility library to do files/io/bytes processing/parsing in file-system or network. 
 
-file engine has two utilities:
-    
-1. list: takes away the headache of 
-    dealing with directories and files, hidden ones, nested ones.
-       
-    It's kind of "ls" command as a package, but doesn't intends
-    to show file properties, permissions or ownership.
-       
-    General packages just take care of reading and accessing
-    files instead of dealing with file permissions.
-
-
-2. reader: binds frequently used file io functions 
-
-    for ex. cloning a file, add to front of a file(reverse append), etc.
-
-    These functions are frequent to use, but not provided by standard go io package.
+1. These features are really common to be implemented for a non-server/local-running application. Though looking fairly easy, almost all had edge cases to be taken care of minutely.
+2. To use a library package instead of custom segments saves redundant testing/debugging.
 
+# Feature list 
+* generate parse tree for given paths
+  * list out files/folders separately
+  * Get hidden files/folders separately
+  * Preserve nested order for dir and files
+  * Control recursion level
+  * Pass custom functions to filter out files and dirs
+  * Include StdIn if valid
+* Encodings
+  * json to 
+    * file
+    * yaml
+  * yaml to
+    * json
+    * file
+  * file to
+    * json 
+    * yaml
+* IO ops
+  * copy multi files to single one
+  * clone file
+  * Pass a callback to be executed over each line of a file
+  * bash `dirname` & `basedir` function
 # How to use
 
 #### use lister