From 0cd6eeef2c3118a3c40ca9ab0e4d311e884ca01d Mon Sep 17 00:00:00 2001
From: Eli <43382407+eli64s@users.noreply.github.com>
Date: Sun, 22 Oct 2023 16:37:55 -0500
Subject: [PATCH] Update project documentation with offline mode example.

---
 README.md                         |  30 +-
 examples/images/readme-offline.md | 743 ++++++++++++++++++++++++++++++
 pyproject.toml                    |   2 +-
 3 files changed, 764 insertions(+), 11 deletions(-)
 create mode 100644 examples/images/readme-offline.md

diff --git a/README.md b/README.md
index 4106f7a3..5266f188 100644
--- a/README.md
+++ b/README.md
@@ -377,7 +377,7 @@ This project is under development with an opinionated setup. It's vital to revie
 <br>
 
 <p align="right">
-  <a href="#top"><b>🔝 Return </b></a>
+  <a href="#top"><b>Return </b></a>
 </p>
 
 ---
@@ -547,13 +547,13 @@ To generate a *README.md* file, use the `readmeai` command in your terminal, alo
 
 To customize the README file generation process, you can modify the project's [configuration file:](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml)
 
-- [*api*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - OpenAI language model API configuration settings.
-- [*base_urls*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Base URLs for supported remote repository platforms.
-- [*cli*]((https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - CLI option settings used by the *readme-ai* application.)
-- [*git*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Default git repository settings used if no repository is provided.
-- [*paths*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Directory paths and files used by the *readme-ai* application.
-- [*prompts*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Large language model prompts used to generate the README file.
-- [*md*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Dynamic Markdown section code templates used to build the README file.
+- **api**: OpenAI language model API configuration settings.
+- **base_urls**: Base URLs for supported remote repository platforms.
+- **cli**: CLI option settings used by the *readme-ai* application.
+- **git**: Default git repository settings used if no repository is provided.
+- **paths**: Directory paths and files used by the *readme-ai* application.
+- **prompts**: Large language model prompts used to generate the README file.
+- **md**: Dynamic Markdown section code templates used to build the README file.
 
 ---
 
@@ -578,12 +578,22 @@ Using `pip`
 readmeai --output readme-ai.md --repository https://github.com/eli64s/readme-ai
 ```
 
-You can also use the `short flags` for the CLI options above. In this example we are naming the output file `readme-ai.md`, setting the repository URL to the *readme-ai* repository, using the `flat-square` badge style, and removing emojis from the README file header names.
+You can also use the `short flags` for the CLI options above.
+
+In this example we name the output file `readme-ai.md`, set the repo URL to *readme-ai*, use the `flat-square` badge style, and remove emojis from the README file header names.
 
 ```bash
 readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai -b flat-square -e false
 ```
 
+Additionally, you can run readme-ai in offline mode, or without an API key! This option is useful for spinning up a baseline README.md file that still contains your project's metadata.
+
+```bash
+readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai --offline true
+```
+
+> Offline mode example [README.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-offline.md)
+
 <br>
 
 Using `docker`
@@ -679,7 +689,7 @@ bash scripts/test.sh
 
 
 <p align="right">
-  <a href="#top"><b>🔝 Return</b></a>
+  <a href="#top"><b>Return</b></a>
 </p>
 
 ---
diff --git a/examples/images/readme-offline.md b/examples/images/readme-offline.md
new file mode 100644
index 00000000..b7b50d69
--- /dev/null
+++ b/examples/images/readme-offline.md
@@ -0,0 +1,743 @@
+<div align="center">
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/PKief/vscode-material-icon-theme/ec559a9f6bfd399b82bb44393651661b08aaf7ba/icons/folder-markdown-open.svg" width="100" />
+<br>FLINK-FLOW</h1>
+<h3>◦ ► INSERT-TEXT</h3>
+<h3>◦ Developed with the software and tools below.</h3>
+
+<p align="center">
+<img src="https://img.shields.io/badge/GNU%20Bash-4EAA25.svg?style=flat-square&logo=GNU-Bash&logoColor=white" alt="GNU%20Bash" />
+<img src="https://img.shields.io/badge/Apache%20Flink-E6526F.svg?style=flat-square&logo=Apache-Flink&logoColor=white" alt="Apache%20Flink" />
+<img src="https://img.shields.io/badge/YAML-CB171E.svg?style=flat-square&logo=YAML&logoColor=white" alt="YAML" />
+<img src="https://img.shields.io/badge/Python-3776AB.svg?style=flat-square&logo=Python&logoColor=white" alt="Python" />
+<img src="https://img.shields.io/badge/AIOHTTP-2C5BB4.svg?style=flat-square&logo=AIOHTTP&logoColor=white" alt="AIOHTTP" />
+<img src="https://img.shields.io/badge/Apache%20Kafka-231F20.svg?style=flat-square&logo=Apache-Kafka&logoColor=white" alt="Apache%20Kafka" />
+<img src="https://img.shields.io/badge/pandas-150458.svg?style=flat-square&logo=pandas&logoColor=white" alt="pandas" />
+</p>
+<img src="https://img.shields.io/github/license/local/flink-flow?style=flat-square&color=5D6D7E" alt="GitHub license" />
+<img src="https://img.shields.io/github/last-commit/local/flink-flow?style=flat-square&color=5D6D7E" alt="git-last-commit" />
+<img src="https://img.shields.io/github/commit-activity/m/local/flink-flow?style=flat-square&color=5D6D7E" alt="GitHub commit activity" />
+<img src="https://img.shields.io/github/languages/top/local/flink-flow?style=flat-square&color=5D6D7E" alt="GitHub top language" />
+</div>
+
+---
+
+## 📖 Table of Contents
+- [📖 Table of Contents](#-table-of-contents)
+- [📍 Overview](#-overview)
+- [📦 Features](#-features)
+- [📂 repository Structure](#-repository-structure)
+- [⚙️ Modules](#modules)
+- [🚀 Getting Started](#-getting-started)
+    - [🔧 Installation](#-installation)
+    - [🤖 Running flink-flow](#-running-flink-flow)
+    - [🧪 Tests](#-tests)
+- [🛣 Roadmap](#-roadmap)
+- [🤝 Contributing](#-contributing)
+- [📄 License](#-license)
+- [👏 Acknowledgments](#-acknowledgments)
+
+---
+
+
+## 📍 Overview
+
+► INSERT-TEXT
+
+---
+
+## 📦 Features
+
+► INSERT-TEXT
+
+---
+
+
+## 📂 Repository Structure
+
+```sh
+└── readmeai/
+    ├── conf/
+    │   ├── conf.toml
+    │   └── flink-config.yaml
+    ├── requirements.txt
+    ├── scripts/
+    │   ├── clean.sh
+    │   └── run.sh
+    ├── setup/
+    │   └── setup.sh
+    ├── setup.py
+    └── src/
+        ├── alerts_handler.py
+        ├── consumer.py
+        └── logger.py
+
+```
+
+---
+
+
+## ⚙️ Modules
+
+| File | Summary |
+| --- | --- |
+| [README.md](README.md) | ► INSERT-TEXT |
+| [requirements.txt](requirements.txt) | ► INSERT-TEXT |
+| [setup.py](setup.py) | ► INSERT-TEXT |
+
+<details closed><summary>.git</summary>
+
+| File | Summary |
+| --- | --- |
+| [HEAD](HEAD) | ► INSERT-TEXT |
+| [config](config) | ► INSERT-TEXT |
+| [description](description) | ► INSERT-TEXT |
+| [index](index) | ► INSERT-TEXT |
+| [packed-refs](packed-refs) | ► INSERT-TEXT |
+
+<details closed><summary>hooks</summary>
+
+| File | Summary |
+| --- | --- |
+| [applypatch-msg.sample](applypatch-msg.sample) | ► INSERT-TEXT |
+| [commit-msg.sample](commit-msg.sample) | ► INSERT-TEXT |
+| [fsmonitor-watchman.sample](fsmonitor-watchman.sample) | ► INSERT-TEXT |
+| [post-update.sample](post-update.sample) | ► INSERT-TEXT |
+| [pre-applypatch.sample](pre-applypatch.sample) | ► INSERT-TEXT |
+| [pre-commit.sample](pre-commit.sample) | ► INSERT-TEXT |
+| [pre-merge-commit.sample](pre-merge-commit.sample) | ► INSERT-TEXT |
+| [pre-push.sample](pre-push.sample) | ► INSERT-TEXT |
+| [pre-rebase.sample](pre-rebase.sample) | ► INSERT-TEXT |
+| [pre-receive.sample](pre-receive.sample) | ► INSERT-TEXT |
+| [prepare-commit-msg.sample](prepare-commit-msg.sample) | ► INSERT-TEXT |
+| [push-to-checkout.sample](push-to-checkout.sample) | ► INSERT-TEXT |
+| [update.sample](update.sample) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>info</summary>
+
+| File | Summary |
+| --- | --- |
+| [exclude](exclude) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>logs</summary>
+
+| File | Summary |
+| --- | --- |
+| [HEAD](HEAD) | ► INSERT-TEXT |
+
+<details closed><summary>refs</summary>
+
+| File | Summary |
+| --- | --- |
+
+<details closed><summary>heads</summary>
+
+| File | Summary |
+| --- | --- |
+| [main](main) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>remotes</summary>
+
+| File | Summary |
+| --- | --- |
+
+<details closed><summary>origin</summary>
+
+| File | Summary |
+| --- | --- |
+| [HEAD](HEAD) | ► INSERT-TEXT |
+
+</details>
+
+
+</details>
+
+
+</details>
+
+
+</details>
+
+
+<details closed><summary>objects</summary>
+
+| File | Summary |
+| --- | --- |
+
+<details closed><summary>07</summary>
+
+| File | Summary |
+| --- | --- |
+| [65545cbfb4d769d97ac31e3282f4807efebeb7](65545cbfb4d769d97ac31e3282f4807efebeb7) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>12</summary>
+
+| File | Summary |
+| --- | --- |
+| [88a44a47b78047eab09f2734b99e35c35e7b34](88a44a47b78047eab09f2734b99e35c35e7b34) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>18</summary>
+
+| File | Summary |
+| --- | --- |
+| [c60e351663ca0662a7171f10fa59d3ba1f51c9](c60e351663ca0662a7171f10fa59d3ba1f51c9) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>1e</summary>
+
+| File | Summary |
+| --- | --- |
+| [3904b0f4b7bded4320eeb4e418a71132aa4480](3904b0f4b7bded4320eeb4e418a71132aa4480) | ► INSERT-TEXT |
+| [a00f8422fa72cfa4e6c86443ecd103a71d7645](a00f8422fa72cfa4e6c86443ecd103a71d7645) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>25</summary>
+
+| File | Summary |
+| --- | --- |
+| [e7c4946bcdd25451a83985f0a395293ac8a91d](e7c4946bcdd25451a83985f0a395293ac8a91d) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>3a</summary>
+
+| File | Summary |
+| --- | --- |
+| [acefdc4ab590fe8fff6bb6eb4c90c3628e9a26](acefdc4ab590fe8fff6bb6eb4c90c3628e9a26) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>44</summary>
+
+| File | Summary |
+| --- | --- |
+| [ee42a944975b0faf87ea3a1fd0896c3803c30d](ee42a944975b0faf87ea3a1fd0896c3803c30d) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>45</summary>
+
+| File | Summary |
+| --- | --- |
+| [36c1a9d168d90065caa1324a6cb7c5a1c17261](36c1a9d168d90065caa1324a6cb7c5a1c17261) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>49</summary>
+
+| File | Summary |
+| --- | --- |
+| [b10f4fb46ed147f706302d88b6c088d161e5b5](b10f4fb46ed147f706302d88b6c088d161e5b5) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>5b</summary>
+
+| File | Summary |
+| --- | --- |
+| [3f6fe7fb354361c8ca0475eaca29d4706540b9](3f6fe7fb354361c8ca0475eaca29d4706540b9) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>5e</summary>
+
+| File | Summary |
+| --- | --- |
+| [1a83cadf0c5c578b9264d0c7cd4dd8808d199d](1a83cadf0c5c578b9264d0c7cd4dd8808d199d) | ► INSERT-TEXT |
+| [6596b3112f02b7801865960d44e80f930a1069](6596b3112f02b7801865960d44e80f930a1069) | ► INSERT-TEXT |
+| [8747f71bac7665b40e823c7903a40d5324589b](8747f71bac7665b40e823c7903a40d5324589b) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>61</summary>
+
+| File | Summary |
+| --- | --- |
+| [b47801102265826a91ca824bf6102076991c83](b47801102265826a91ca824bf6102076991c83) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>65</summary>
+
+| File | Summary |
+| --- | --- |
+| [cc662587be36b5f09c065bd1f5e2af5e2bf80a](cc662587be36b5f09c065bd1f5e2af5e2bf80a) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>66</summary>
+
+| File | Summary |
+| --- | --- |
+| [73f1e7e30bade581d4af58eede0f96e521ab3f](73f1e7e30bade581d4af58eede0f96e521ab3f) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>73</summary>
+
+| File | Summary |
+| --- | --- |
+| [5283927f4068960c485f1347507d175ca72d36](5283927f4068960c485f1347507d175ca72d36) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>77</summary>
+
+| File | Summary |
+| --- | --- |
+| [8a3d81c29260526f23839ec5832e7ff04499ae](8a3d81c29260526f23839ec5832e7ff04499ae) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>84</summary>
+
+| File | Summary |
+| --- | --- |
+| [e90c75b77c06a183c2daef2f731e7c1f76c859](e90c75b77c06a183c2daef2f731e7c1f76c859) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>85</summary>
+
+| File | Summary |
+| --- | --- |
+| [51b3055b105739c035e6bf038b6da9def51156](51b3055b105739c035e6bf038b6da9def51156) | ► INSERT-TEXT |
+| [e0d3b2f33624e4553113ead236d30f73f7a84c](e0d3b2f33624e4553113ead236d30f73f7a84c) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>8a</summary>
+
+| File | Summary |
+| --- | --- |
+| [fe8f5f7aeb85baa696da77e4bc7ff87f3e36d7](fe8f5f7aeb85baa696da77e4bc7ff87f3e36d7) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>8b</summary>
+
+| File | Summary |
+| --- | --- |
+| [fae52b0f3e2c7b351c4c483ff56302cceea13a](fae52b0f3e2c7b351c4c483ff56302cceea13a) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>8c</summary>
+
+| File | Summary |
+| --- | --- |
+| [defcdc2fdf4b5655589bf79dc7a9ab0fc09678](defcdc2fdf4b5655589bf79dc7a9ab0fc09678) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>92</summary>
+
+| File | Summary |
+| --- | --- |
+| [0b6b9d96c36dee39f009582d1f15178d590adb](0b6b9d96c36dee39f009582d1f15178d590adb) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>94</summary>
+
+| File | Summary |
+| --- | --- |
+| [dfc2dbaf816957bceccdee57d0d9916ebc7128](dfc2dbaf816957bceccdee57d0d9916ebc7128) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>a0</summary>
+
+| File | Summary |
+| --- | --- |
+| [c54b94e1922168249acc837b61a186406b82f7](c54b94e1922168249acc837b61a186406b82f7) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>a2</summary>
+
+| File | Summary |
+| --- | --- |
+| [1bf35c1aa7a382ddb128c8371cec907a9ecea1](1bf35c1aa7a382ddb128c8371cec907a9ecea1) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>a4</summary>
+
+| File | Summary |
+| --- | --- |
+| [4e6b150e009a2fcd74cbc67f6058ac8da1794b](4e6b150e009a2fcd74cbc67f6058ac8da1794b) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>b1</summary>
+
+| File | Summary |
+| --- | --- |
+| [11e91b8a917a7a47259baecbeb753484306612](11e91b8a917a7a47259baecbeb753484306612) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>b6</summary>
+
+| File | Summary |
+| --- | --- |
+| [8b4536808257f0553d0499a953a3bfb82fb890](8b4536808257f0553d0499a953a3bfb82fb890) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>b7</summary>
+
+| File | Summary |
+| --- | --- |
+| [b03a1996f212cf478a2c161f0e405f0e4ac3fa](b03a1996f212cf478a2c161f0e405f0e4ac3fa) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>be</summary>
+
+| File | Summary |
+| --- | --- |
+| [f69cdc70f31a339c09a5edd2d2e45c5894e67b](f69cdc70f31a339c09a5edd2d2e45c5894e67b) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>c6</summary>
+
+| File | Summary |
+| --- | --- |
+| [0d27d67c56551b9a105758932fe4b0c27f4dfd](0d27d67c56551b9a105758932fe4b0c27f4dfd) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>c8</summary>
+
+| File | Summary |
+| --- | --- |
+| [7c486abbe80e3146be4b4727c01f5c01c4c417](7c486abbe80e3146be4b4727c01f5c01c4c417) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>c9</summary>
+
+| File | Summary |
+| --- | --- |
+| [d2a82d96226a053f4fbc111d12878841881230](d2a82d96226a053f4fbc111d12878841881230) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>cc</summary>
+
+| File | Summary |
+| --- | --- |
+| [8e4baf489efe8d3f3e7811f75e553b34d93952](8e4baf489efe8d3f3e7811f75e553b34d93952) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>d2</summary>
+
+| File | Summary |
+| --- | --- |
+| [6b979f661aa2f1f1e3f8be90485aff38048772](6b979f661aa2f1f1e3f8be90485aff38048772) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>df</summary>
+
+| File | Summary |
+| --- | --- |
+| [2de87775930b7ba34826270a740694eba629be](2de87775930b7ba34826270a740694eba629be) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>e8</summary>
+
+| File | Summary |
+| --- | --- |
+| [c8b234adc41fbb0c3e03f45c0901e6e7b9611b](c8b234adc41fbb0c3e03f45c0901e6e7b9611b) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>f3</summary>
+
+| File | Summary |
+| --- | --- |
+| [48c5316be2dab4cd4ff1942f45d83ddfb50198](48c5316be2dab4cd4ff1942f45d83ddfb50198) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>f7</summary>
+
+| File | Summary |
+| --- | --- |
+| [1d84a0527f96798b925815d0c7629f3f0c8e1b](1d84a0527f96798b925815d0c7629f3f0c8e1b) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>info</summary>
+
+| File | Summary |
+| --- | --- |
+
+</details>
+
+
+<details closed><summary>pack</summary>
+
+| File | Summary |
+| --- | --- |
+
+</details>
+
+
+</details>
+
+
+<details closed><summary>refs</summary>
+
+| File | Summary |
+| --- | --- |
+
+<details closed><summary>heads</summary>
+
+| File | Summary |
+| --- | --- |
+| [main](main) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>remotes</summary>
+
+| File | Summary |
+| --- | --- |
+
+<details closed><summary>origin</summary>
+
+| File | Summary |
+| --- | --- |
+| [HEAD](HEAD) | ► INSERT-TEXT |
+
+</details>
+
+
+</details>
+
+
+<details closed><summary>tags</summary>
+
+| File | Summary |
+| --- | --- |
+
+</details>
+
+
+</details>
+
+
+</details>
+
+
+<details closed><summary>conf</summary>
+
+| File | Summary |
+| --- | --- |
+| [conf.toml](conf.toml) | ► INSERT-TEXT |
+| [flink-config.yaml](flink-config.yaml) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>data</summary>
+
+| File | Summary |
+| --- | --- |
+| [data.csv](data.csv) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>scripts</summary>
+
+| File | Summary |
+| --- | --- |
+| [clean.sh](clean.sh) | ► INSERT-TEXT |
+| [run.sh](run.sh) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>setup</summary>
+
+| File | Summary |
+| --- | --- |
+| [setup.sh](setup.sh) | ► INSERT-TEXT |
+
+</details>
+
+
+<details closed><summary>src</summary>
+
+| File | Summary |
+| --- | --- |
+| [alerts_handler.py](alerts_handler.py) | ► INSERT-TEXT |
+| [consumer.py](consumer.py) | ► INSERT-TEXT |
+| [logger.py](logger.py) | ► INSERT-TEXT |
+
+</details>
+
+
+---
+
+## 🚀 Getting Started
+
+***Dependencies***
+
+Please ensure you have the following dependencies installed on your system:
+
+`- ℹ️ Dependency 1`
+
+`- ℹ️ Dependency 2`
+
+`- ℹ️ ...`
+
+### 🔧 Installation
+
+1. Clone the flink-flow repository:
+```sh
+git clone /Users/k01101011/Documents/GitHub/flink-flow
+```
+
+2. Change to the project directory:
+```sh
+cd flink-flow
+```
+
+3. Install the dependencies:
+```sh
+► INSERT-TEXT
+```
+
+### 🤖 Running flink-flow
+
+```sh
+► INSERT-TEXT
+```
+
+### 🧪 Tests
+```sh
+► INSERT-TEXT
+```
+
+---
+
+
+## 🛣 Project Roadmap
+
+> - [X] `ℹ️  Task 1: Implement X`
+> - [ ] `ℹ️  Task 2: Implement Y`
+> - [ ] `ℹ️ ...`
+
+
+---
+
+## 🤝 Contributing
+
+[**Discussions**](https://github.com/local/flink-flow/discussions)
+  - Join the discussion here.
+
+[**New Issue**](https://github.com/local/flink-flow/issues)
+  - Report a bug or request a feature here.
+
+[**Contributing Guidelines**](https://github.com/local/flink-flow/blob/main/CONTRIBUTING.md)
+
+- Contributions are welcome! Please follow these steps:
+
+1. Fork the project repository to your GitHub account.
+2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
+3. Create a new branch with a descriptive such as `new-feature-x` or `bugfix-issue-x`.
+```sh
+git checkout -b new-feature-x
+```
+4. Develop your changes locally.
+5. Commit your updates with a clear explanation of the changes you've made.
+```sh
+git commit -m 'Implemented new feature.'
+```
+6. Push your changes to your forked repository on GitHub.
+```sh
+git push origin new-feature-x
+```
+7. Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary.
+8. Once your pull request is reviewed, it will be merged into the main branch of the project repository.
+
+---
+
+## 📄 License
+
+
+This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
+
+---
+
+## 👏 Acknowledgments
+
+- List any resources, contributors, inspiration, etc. here.
+
+[**Return**](#Top)
+
+---
diff --git a/pyproject.toml b/pyproject.toml
index c995553c..4be89df0 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "readmeai"
-version = "0.4.032"
+version = "0.4.034"
 description = "Generate beautiful README.md files from the terminal, powered by AI."
 authors = ["Eli <0x.eli.64s@gmail.com>"]
 license = "MIT"