Update project example readme files and images.

README.md

@@ -75,9 +75,9 @@ You can also generate README files without an API key by using the `--offline` C
 
 ## 🔮 Features
 
-Built with flexibility in mind, readme-ai allows users to customize various aspects of the README file using CLI options and configuration settings. Content is generated using a combination of data extraction and making a few calls to LLM APIs.
+Built with flexibility in mind, readme-ai allows users to customize various aspects of the README using CLI options and configuration settings. Content is generated using a combination of data extraction and making a few calls to LLM APIs.
 
-Currently, readme-ai uses generative ai to create four distinct sections of the README file.
+Currently, readme-ai uses generative ai to create four sections of the README file.
 
 > i. **Header**: Project slogan that describes the repository in an engaging way.
 >
@@ -97,42 +97,46 @@ The header section is built using repository metadata and CLI options. Key featu
 - **Project Slogan**: Catch phrase that describes the project, generated by generative ai.
 - **Table of Contents/Quick Links**: Links to the different sections of the README file.
 
-Below are a few examples of README headers generated by the readme-ai tool.
+See a few examples headers generated by *readme-ai* below.
 <table>
+  <!-- row 1 -->
   <tr>
     <td colspan="2" align="center">
       <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-default.png" alt="large-repo" width="800"/><br>
       <code>default output (no options provided to cli)</code>
     </td>
   </tr>
+  <!-- row 2 -->
   <tr>
     <td align="center">
-      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-flat.png" alt="flat" width="400"/><br>
-      <code>--badges flat --image black</code>
+      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-cloud.png" alt="cloud-db-logo" width="400"/><br>
+      <code>--align left --badges flat-square --image cloud</code>
     </td>
     <td align="center">
-      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-offline.png" alt="flat" width="400"/><br>
-      <code>--badges flat-square --offline</code>
+      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-gradient.png" alt="gradient-markdown-logo" width="400"/><br>
+      <code>--align left --badges flat --image gradient</code>
     </td>
   </tr>
+  <!-- row 3 -->
   <tr>
     <td align="center">
-      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-plastic.png" alt="plastic" width="400"/><br>
-      <code>--badges plastic --image grey</code>
+      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-custom.png" alt="custom-logo" width="400"/><br>
+      <code>--badges flat --image custom</code>
     </td>
     <td align="center">
-      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-purple.png" alt="large-repo" width="400"/><br>
-      <code>--align left --badges flat --image purple</code>
+      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-skills-light.png" alt="skills-light" width="400"/><br>
+      <code>--badges skills-light --image grey</code>
     </td>
   </tr>
   <tr>
+  <!-- row 4 -->
     <td align="center">
-      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-skills-light.png" alt="skills-light" width="400"/><br>
-      <code>--badges skills-light --image grey</code>
+      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-flat-square.png" alt="readme-ai-header" width="400"/><br>
+      <code>--badges flat-square</code>
     </td>
     <td align="center">
-      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-skills-dark.png" alt="skills" width="400"/><br>
-      <code>--align left --badges skills --image yellow</code>
+      <img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-black.png" alt="black-logo" width="400"/><br>
+      <code>--badges flat --image black</code>
     </td>
   </tr>
 </table>
@@ -291,6 +295,12 @@ See the <a href="#-configuration">Configuration</a> section below for the comple
         <td><a href="https://github.com/rumaan/file.io-Android-Client">file.io-android-client</a></td>
         <td>Kotlin, Java, Android</td>
       </tr>
+      <tr>
+        <td>5️⃣</td>
+        <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-streamlit.md">readme-streamlit.md</a></td>
+        <td><a href="https://github.com/eli64s/readme-ai-streamlit">readme-ai-streamlit</a></td>
+        <td>Python, Streamlit</td>
+      </tr>
       <tr>
         <td>5️⃣</td>
         <td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-rust-c.md">readme-rust-c.md</a></td>
@@ -450,7 +460,7 @@ readmeai -r https://github.com/eli64s/readme-ai
 
 Using `streamlit`
 
-[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://readmeai.streamlit.app/)
+[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://readme-ai.streamlit.app/)
 
 > [!NOTE]
 >
@@ -658,7 +668,7 @@ The configurations are loaded using the `load_config` function, which parses a T
 - [X] Containerize the readme-ai CLI as a Docker image via Docker Hub.
   - [*Docker Hub Image*](https://hub.docker.com/repository/docker/zeroxeli/readme-ai/general)
 - [X] Serve the readme-ai CLI as a web app, deployed on Streamlit Community Cloud.
-  - [*Streamlit Web Application*](https://readmeai.streamlit.app/)
+  - [*Streamlit Web Application*](https://readme-ai.streamlit.app/)
 - [ ] Integrate singular interface for all LLM API providers (Anthropic, Cohere, Gemini, etc.)
 - [ ] Design template system to give users a variety of README document flavors (ai, data, web, etc.)
 - [ ] Develop robust documentation generation process to extend to full project docs (i.e. Sphinx, MkDocs, etc.)

examples/markdown/readme-mlops.md

@@ -1,5 +1,5 @@
 <p align="left">
-  <img src="https://raw.githubusercontent.com/PKief/vscode-material-icon-theme/ec559a9f6bfd399b82bb44393651661b08aaf7ba/icons/folder-markdown-open.svg" width="100" />
+  <img src="https://img.icons8.com/external-tal-revivo-regular-tal-revivo/96/external-readme-is-a-easy-to-build-a-developer-hub-that-adapts-to-the-user-logo-regular-tal-revivo.png" width="100" />
 </p>
 <p align="left">
     <h1 align="left">MLOPS-COURSE</h1>
@@ -8,30 +8,29 @@
     <em>Streamline, Optimize, Innovate. MLOps made simple.</em>
 </p>
 <p align="left">
-	<img src="https://img.shields.io/github/license/GokuMohandas/mlops-course?style=flat-square&color=0080ff" alt="license">
-	<img src="https://img.shields.io/github/last-commit/GokuMohandas/mlops-course?style=flat-square&color=0080ff" alt="last-commit">
-	<img src="https://img.shields.io/github/languages/top/GokuMohandas/mlops-course?style=flat-square&color=0080ff" alt="repo-top-language">
-	<img src="https://img.shields.io/github/languages/count/GokuMohandas/mlops-course?style=flat-square&color=0080ff" alt="repo-language-count">
+	<img src="https://img.shields.io/github/license/GokuMohandas/mlops-course?style=flat&color=0080ff" alt="license">
+	<img src="https://img.shields.io/github/last-commit/GokuMohandas/mlops-course?style=flat&color=0080ff" alt="last-commit">
+	<img src="https://img.shields.io/github/languages/top/GokuMohandas/mlops-course?style=flat&color=0080ff" alt="repo-top-language">
+	<img src="https://img.shields.io/github/languages/count/GokuMohandas/mlops-course?style=flat&color=0080ff" alt="repo-language-count">
 <p>
 <p align="left">
 		<em>Developed with the software and tools below</em>
 </p>
 <p align="left">
-	<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/precommit-FAB040.svg?style=flat-square&logo=pre-commit&logoColor=black" alt="precommit">
-	<img src="https://img.shields.io/badge/scikitlearn-F7931E.svg?style=flat-square&logo=scikit-learn&logoColor=white" alt="scikitlearn">
-	<img src="https://img.shields.io/badge/Jupyter-F37626.svg?style=flat-square&logo=Jupyter&logoColor=white" alt="Jupyter">
-	<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/GitHub%20Actions-2088FF.svg?style=flat-square&logo=GitHub-Actions&logoColor=white" alt="GitHub%20Actions">
+	<img src="https://img.shields.io/badge/GNU%20Bash-4EAA25.svg?style=flat&logo=GNU-Bash&logoColor=white" alt="GNU%20Bash">
+	<img src="https://img.shields.io/badge/precommit-FAB040.svg?style=flat&logo=pre-commit&logoColor=black" alt="precommit">
+	<img src="https://img.shields.io/badge/scikitlearn-F7931E.svg?style=flat&logo=scikit-learn&logoColor=white" alt="scikitlearn">
+	<img src="https://img.shields.io/badge/Jupyter-F37626.svg?style=flat&logo=Jupyter&logoColor=white" alt="Jupyter">
+	<img src="https://img.shields.io/badge/YAML-CB171E.svg?style=flat&logo=YAML&logoColor=white" alt="YAML">
+	<img src="https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white" alt="Python">
 	<br>
-	<img src="https://img.shields.io/badge/pandas-150458.svg?style=flat-square&logo=pandas&logoColor=white" alt="pandas">
-	<img src="https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat-square&logo=Pytest&logoColor=white" alt="Pytest">
-	<img src="https://img.shields.io/badge/Ray-028CF0.svg?style=flat-square&logo=Ray&logoColor=white" alt="Ray">
-	<img src="https://img.shields.io/badge/MLflow-0194E2.svg?style=flat-square&logo=MLflow&logoColor=white" alt="MLflow">
-	<img src="https://img.shields.io/badge/NumPy-013243.svg?style=flat-square&logo=NumPy&logoColor=white" alt="NumPy">
-	<img src="https://img.shields.io/badge/FastAPI-009688.svg?style=flat-square&logo=FastAPI&logoColor=white" alt="FastAPI">
-	<img src="https://img.shields.io/badge/Markdown-000000.svg?style=flat-square&logo=Markdown&logoColor=white" alt="Markdown">
+	<img src="https://img.shields.io/badge/pandas-150458.svg?style=flat&logo=pandas&logoColor=white" alt="pandas">
+	<img src="https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white" alt="Pytest">
+	<img src="https://img.shields.io/badge/Ray-028CF0.svg?style=flat&logo=Ray&logoColor=white" alt="Ray">
+	<img src="https://img.shields.io/badge/MLflow-0194E2.svg?style=flat&logo=MLflow&logoColor=white" alt="MLflow">
+	<img src="https://img.shields.io/badge/FastAPI-009688.svg?style=flat&logo=FastAPI&logoColor=white" alt="FastAPI">
+	<img src="https://img.shields.io/badge/NumPy-013243.svg?style=flat&logo=NumPy&logoColor=white" alt="NumPy">
+	<img src="https://img.shields.io/badge/Markdown-000000.svg?style=flat&logo=Markdown&logoColor=white" alt="Markdown">
 </p>
 <hr>
 
@@ -40,12 +39,12 @@
 - [📍 Overview](#-overview)
 - [📦 Features](#-features)
 - [📂 Repository Structure](#-repository-structure)
-- [🧩 Modules](#modules)
+- [🧩 Modules](#-modules)
 - [🚀 Getting Started](#-getting-started)
-    - [⚙️ Installation](#-installation)
-    - [🤖 Running mlops-course](#-running-mlops-course)
-    - [🧪 Tests](#-tests)
-- [🛠 Roadmap](#-roadmap)
+  - [⚙️ Installation](#️-installation)
+  - [🤖 Running mlops-course](#-running-mlops-course)
+  - [🧪 Tests](#-tests)
+- [🛠 Project Roadmap](#-project-roadmap)
 - [🤝 Contributing](#-contributing)
 - [📄 License](#-license)
 - [👏 Acknowledgments](#-acknowledgments)