docs(readme): Update readme for clarity - wip: adding variable paths to docs

style: remove deadcode

Author: MrDwarf7

README.md

@@ -2,20 +2,23 @@
 
 ## Overview
 
-This program provides a CLI tool to parse CSV files, filtering out columns & rows based on criteria specified in a configuration file (`config.json`).
-Users can optionally override settings using command-line arguments, ensuring flexibility and adaptability to various use cases.
+This program provides a CLI tool to parse CSV files, filtering out columns &
+rows based on criteria specified in a configuration file (`.\config\config.json`).
+Users can optionally override settings using command-line arguments, 
+ensuring flexibility and adaptability to various use cases.
 
 ## Configuration
 
-> In the follow example(s) `$ROOT` is the directory the binary/`.exe` resides in.
+> In the follow example(s) `$ROOT` is the directory of the binary file or `.exe`.
 
 By default, the program will search for a config directory & config file in the following locations:
 `$ROOT/config` & `$ROOT/config/config.json` respectively.
 
-If the config folder or the config file is not found,
-the program will generate a dummy config file with similar struct and values to the below snippet in a `config` directory in the root of the binary.
+If the config folder and/or the config file is not found,
+the program will generate a 'dummy' config file with similar structure & values to the snippet below.
+You can find the newly created file at `$ROOT/config/config.json`.
 
-The configuration file (`config.json`) should be formatted as follows:
+The configuration file (`$ROOT/config/config.json`) should be formatted as follows:
 
 ```json
 {
@@ -44,8 +47,8 @@ The configuration file (`config.json`) should be formatted as follows:
 }
 ```
 
-- Note: The code handles both Windows and Linux-style paths.
-  This does not mean the Filesystem you're interacting with via the tool will necessarily play nice.
+- Pro-Tip!: The code handles both Windows and Linux-style paths.
+That being said - Filesystem themselves may not play nicely if you're mixing OS paths.
 
 ### Fields:
 

src/prelude.rs

@@ -77,20 +77,6 @@ pub fn update() -> Result<String> {
             Ok(self_update::cargo_crate_version!().to_string())
         }
     }
-
-    // let status = match std::thread::spawn(stauts_cls).join().unwrap() {
-    //     Ok(v) => {
-    //         info!("Update successful. Restarting with new version");
-    //         v
-    //     }
-    //     Err(_) => {
-    //         error!("Error updating.");
-    //         warn!("Update not completed. Continuing with current version");
-    //         return Ok(self_update::cargo_crate_version!().to_string());
-    //     }
-    // };
-
-    // Ok(status.version().to_string())
 }
 
 fn first_author() -> String {
@@ -104,13 +90,4 @@ pub const NO_CONFIG_FILE_MSG: &str = r#"
     Config file either doesn't exist,
     is empty, or there was an error parsing it.
     Please check the config.json file.
-    "#;
-
-// "Config file either doesn't exist,\n
-//              is empty,\n
-//               or there was an error parsing it,\n
-//                please check the config.json file",
-//
-//
-//
-//
+    "#;

src/state.rs

@@ -33,8 +33,6 @@ pub struct State<'a> {
     pub config: Config,
     pub retained_data: RetainedData,
     pub csv_pipeline: CsvPipeline,
-    // pub handler: CsvHandler,
-    // pub processor: Processor,
     pub output_data: OutputData,
     phantom_data: PhantomData<&'a ()>,
 }
@@ -114,7 +112,6 @@ impl State<'_> {
     /// state.process(&mut rdr).expect("Failed to process CSV data");
     /// ```
     pub fn process(&mut self) -> Result<()> {
-        // Processor::process(&mut self.retained_data, &self.handler, rdr)
         self.csv_pipeline.process(&mut self.retained_data)
     }
 
@@ -130,7 +127,6 @@ impl State<'_> {
     /// ```
     pub fn deduplicate(&mut self) {
         self.csv_pipeline.deduplicate(&mut self.retained_data);
-        // self.processor.deduplicate(&mut self.retained_data);
     }
 
     /// Outputs the retained data based on the configured output type.