From 47b85d4ecd4f83af2f02533a3abb6aad23730858 Mon Sep 17 00:00:00 2001
From: Kevin Veen-Birkenbach <kevin@veen.world>
Date: Tue, 22 Aug 2023 22:26:03 +0200
Subject: [PATCH] Update README.md

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 770e85f..4fd282c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,45 @@
 # bulk-string-replacer
-This tool traverses a specified directory to search and replace strings within filenames, folder names, and file contents. With various flags, users can control recursion, target hidden items, and preview changes before execution. It's a versatile utility for bulk modifications.
+bulk-string-replacer is a tool designed to traverse directories and perform bulk string replacement in filenames, folder names, and file contents. Whether you want to target hidden items, preview changes before execution, or recursively navigate through folders, this versatile utility has you covered.
+
+## Author
+
+Kevin Veen-Birkenbach  
+- 📧 Email: [kevin@veen.world](mailto:kevin@veen.world)
+- 🌍 Website: [https://www.veen.world/](https://www.veen.world/)
+
+## Link to Original Conversation
+
+For more context on how this tool was developed, you can [view the original conversation here](https://chat.openai.com/share/8567c240-3905-4521-b30e-04104015bb9b).
+
+## Setup and Usage
+
+1. Clone the repository:
+    ```bash
+    git clone https://github.com/kevinveenbirkenbach/bulk-string-replacer.git
+    ```
+
+2. Navigate to the cloned directory:
+    ```bash
+    cd bulk-string-replacer
+    ```
+
+3. Run the script with Python:
+    ```bash
+    python replace_string.py [path] [old_string] [new_string] [options]
+    ```
+
+### Options:
+
+- `--recursive`: Replace in all subdirectories and files.
+- `--folder`: Replace in folder names.
+- `--files`: Replace in file names.
+- `--content`: Replace inside file contents.
+- `--preview`: Preview changes without making actual replacements.
+- `--verbose`: Verbose mode - view detailed outputs.
+- `--hidden`: Target hidden files and folders.
+
+For more detailed options, refer to the inline script help or the aforementioned conversation.
+
+## License
+
+This project is licensed under the GNU Affero General Public License v3.0. The full license text is available in the `LICENSE` file of this repository.