Enhanced documentation, tooltips and screenshots (#33)

* Enhanced documentation, tooltips and screenshots

* Updated file names

Author: cyrus2281

README.md

@@ -1,59 +1,101 @@
 # Eco-Search
+
 [![release](https://img.shields.io/github/v/release/cyrus2281/Echo-Search?color=00ff00)](https://github.com/cyrus2281/Echo-Search/releases)
 [![version](https://img.shields.io/github/package-json/v/cyrus2281/Echo-Search)](https://github.com/cyrus2281/Echo-Search)
 [![License](https://img.shields.io/github/license/cyrus2281/echo-search)](https://github.com/cyrus2281/Echo-Search/blob/main/LICENSE)
 [![react](https://img.shields.io/github/package-json/dependency-version/cyrus2281/Echo-Search/react?logo=react&color=lightblue)](https://reactjs.org/)
 [![electron](https://img.shields.io/github/package-json/dependency-version/cyrus2281/Echo-Search/dev/electron?logo=electron&color=lightblue&logoColor=lightblue)](https://www.electronjs.org/)
+[![buyMeACoffee](https://img.shields.io/badge/BuyMeACoffee-cyrus2281-yellow?logo=buymeacoffee)](https://www.buymeacoffee.com/cyrus2281)
 <br>
 
-This application will crawl recursively through the given parent directory and will look for the given string/regular expression in all text files and replace it with the given string.
+Echo Search is a feature-rich and powerful application that allows you to search for a specific text or regular expression query in the content of files within a directory and its subdirectories. It also offers the ability to replace the found text with another string of your choice. With its wide range of options and capabilities, it is an ideal solution for software developers, data analysts, and anyone looking for an efficient way to search and replace text in files.
 
-You can select multiple parent directories, mark search as case insensitive or matching whole words, provide a multi-line search query, include specific files types, exclude paths or file types, and even configure the regex search modifier flags. You can use concurrency to run the application on multiple threads.
+## Key Features
 
-You get a live report on the search happening in the provided console in the app and you can open each file with desktop's default app or in the respective folder.
+- Search for text or regular expressions: Echo Search supports both simple text queries and complex regular expression queries.
 
-This app is only for text based files and can NOT be used with files such as pdf, doc, excel, etc.
+- Multi-line queries: You can search for text across multiple lines in a single file.
 
-The app is written with Electron (Node) for the backend, and React (JavaScript) for the frontend.
+- Search only mode: If you just want to search for files that contain a specific query, Echo Search has a search only mode that allows you to do just that, without making any replacements.
 
-<br>
+- Case sensitivity: You can choose whether the search should be case sensitive or not.
 
-# Installation
+- Whole word match or partial match: You can choose to search for the entire word only, or allow for partial matches.
 
-1. Download the `latest` release for your operating system from [Releases](https://github.com/cyrus2281/Echo-Search/releases).
+- Multiple parent directories: You can select multiple parent directories to search in, making it easy to search across a wide range of files.
 
-   - Open the latest release
-   - From `Assets` download the version for your operating system
-     - Windows: echo-search-X.X.X.WIN.Setup.exe
-     - MacOS: echo-search-darwin-x64-X.X.X.zip
-     - Linux: clone the code and run `npm i && npm run make:linux`
+- File extension options: You can choose to search in all file types, or select specific file extensions to focus on. You can also exclude specific file extensions if desired.
 
-2. Install the app by running the file.
-3. a shortcut should appear on your desktop/app bar.
+- Concurrent processing: Echo Search supports concurrent processing, allowing you to run the application in multiple threads for faster results. You can select up to 80% of the available cores.
 
-That's it. Enjoy the app.
+- Regular expression flags: Echo Search supports a range of regular expression flags, allowing you to customize the search even further.
 
-# Demo of Application
+- Live feedback console: Echo Search provides a console with live feedback on the progress of the search, making it easy to monitor its progress. You can also clear the console at any time.
 
-### Echo Search Empty
+- Direct file and directory access: You can open the updated files or their directories with the file pre-selected directly from the console.
+
+***Note:** This app is only for text based files and can NOT be used with files such as pdf, doc, excel, etc.*
 
-<img src="./images/baseapp.png" />
 <hr>
 
-### Echo Search Filled
+## Installation
 
-<img src="./images/filled.png" />
-<hr>
+### Windows
+
+1. Open the `latest` release from [Releases](https://github.com/cyrus2281/Echo-Search/releases).
+2. From `Assets` download the `exe` version.
+   `Echo Search-X.X.X.WIN.Setup.exe`
+3. Install the app by running (double clicking) the file.
 
-### Echo Search Sample output
+### MacOS
+
+1. Open the `latest` release from [Releases](https://github.com/cyrus2281/Echo-Search/releases).
+2. From `Assets` download the `zip` version.
+   `Echo Search-darwin-x64-X.X.X.zip`
+3. After downloading the zip, double click on it to extract the file.
+4. Right click on the file and select open. You might see a warning that the developer is unknown, accept and open the app (this is because the app is not registered under the apple's paid subscription).
+5. Drag and move the app to the application folder.
+
+### Linux
+
+1. Open the `latest` release from [Releases](https://github.com/cyrus2281/Echo-Search/releases).
+2. From `Assets` download the `source code`
+3. unzip the code
+4. from within the repository run: `npm i && npm run make:linux`
+5. the app will be built in the `out` directory (exact path will be visible in the terminal)
+
+That's it. Enjoy the app.
 
-<img src="./images/running.png" />
 <hr>
 
+Echo Search is a versatile and efficient tool for searching and replacing text in files. With its extensive range of options and capabilities, it is suitable for a wide range of use cases, whether you are a software developer looking for a quick way to update code, or a data analyst searching for specific information in large datasets. Try Echo Search today and see how it can make your life easier.
+
+## Application Screenshots
+
+<div style="display:flex; gap:2%;">
+  <img src="./images/baseapp.png" width="49%" />
+  <img src="./images/options.png" width="49%" />
+</div>
+<br>
+<div style="display:flex; gap:2%;">
+  <img src="./images/filled.png" width="49%" />
+  <img src="./images/running.png"  width="49%" />
+</div>
+
+## License
+
+The app is written using Electron (NodeJS) and React.
+
+Echo Search is licensed under the [BSD 3-Clause](./LICENSE).
+
 ## Java
 
 This app was originally written in Java. the source code for the legacy version is still available in the `Java` directory.
 
 NOTICE: this version is no longer supported the the latest release is the recommend version to use.
 
+<br>
+
+<hr>
+
 Copyright(c) Cyrus Mobini 2023

images/baseapp.png

@@ -1,8 +1,8 @@
 {
   "name": "echo-search",
-  "productName": "echo-search",
-  "version": "2.4.7",
-  "description": "An application to search and replace strings in files recursively",
+  "productName": "Echo Search",
+  "version": "2.4.8",
+  "description": "Echo Search is a feature-rich application designed to help you search and replace text within the contents of files in a directory and its subdirectories.",
   "main": ".webpack/main",
   "scripts": {
     "start": "cross-env NODE_ENV=development electron-forge start",
@@ -17,7 +17,9 @@
     "update:minor": "npm version minor",
     "update:patch": "npm version patch --no-git-tag-version --no-commit-hooks"
   },
-  "keywords": [],
+  "keywords": [
+    "search", "find", "replace", "findAll", "replaceAll", "findAndReplace", "searchAndReplace"
+  ],
   "author": {
     "name": "Cyrus Mobini",
     "url": "https://github.com/cyrus2281"

images/filled.png

@@ -54,7 +54,7 @@ function ExcludeSelector({ form }) {
         <Box sx={{ width: "100%", display: "flex", alignItems: "center" }}>
           <Typography variant="body1">Files/Directories To Exclude:</Typography>
           <Tooltip
-            title="Path can complete or partial match. It can also be used to exclude specific file extensions."
+            title="Paths can be complete or partial match. It can also be used to exclude specific file extensions."
             sx={{ ml: 1 }}
           >
             <IconButton>

images/options.png

@@ -23,9 +23,9 @@ const MultiThreadingTooltip = styled(({ className, ...props }) => (
         Higher number of threads does NOT mean faster results. Concurrency
         depends on different factors such as the <em>number of threads</em>,
         <em> power of each core</em>, and the
-        <em> amount of available memory</em>. Note that concurrency uses
-        considerably more amount memory. Please be sure not overload your system
-        memory. With Concurrency you might feel some asynchronously or miss some
+        <em> amount of the available memory</em>. Note that concurrency uses
+        considerably more amount of memory. Please be sure not overload your system
+        memory. With Concurrency you might feel some asynchronous behavior or miss some
         messages. <br></br> You're not allowed to use more than <b>80%</b> of
         your CPU cores.<br></br> We recommend testing with different number of
         threads to find the best performance.

images/running.png

@@ -21,7 +21,7 @@ const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
 
 const testDir = path.join(__dirname, "testDir");
 
-describe("Echo-Search.js", function () {
+describe("Echo-Search", function () {
   // make test environment
   beforeEach(function () {
     // create directory testDir