From 2d0ca90232d4a5e0ca75f06e0064efab965f9901 Mon Sep 17 00:00:00 2001
From: DikshaDisciplines <158307974+DikshaDisciplines@users.noreply.github.com>
Date: Mon, 17 Feb 2025 10:44:27 +0530
Subject: [PATCH] Update README.md

---
 lib/blog_metadata/README.md | 43 ++++++++++++++++++++++++-------------
 1 file changed, 28 insertions(+), 15 deletions(-)

diff --git a/lib/blog_metadata/README.md b/lib/blog_metadata/README.md
index c468ca5a..4d7a72e7 100644
--- a/lib/blog_metadata/README.md
+++ b/lib/blog_metadata/README.md
@@ -1,34 +1,47 @@
+# AI Blog Metadata Generator
 
-#AI Blog Metadata Generator
-This document outlines the AI Blog Metadata Generator module, designed to assist in creating SEO-optimized metadata for blog articles. This module utilizes artificial intelligence to generate high-quality, engaging, and SEO-friendly content. Below, you will find the details of the module's functionalities, prerequisites, installation process, and usage instructions.
+The AI Blog Metadata Generator module is designed to assist in creating SEO-optimized metadata for blog articles. Utilizing artificial intelligence, this module generates high-quality metadata to enhance the visibility and engagement of blog posts.
 
 ## Prerequisites
+
 To use this module, ensure that the following prerequisites are met:
 
-Python 3.6 or higher
-Streamlit
-Loguru
-Asyncio
-A GPT provider (e.g., OpenAI, Gemini)
-Installation
-Install the required packages using the Python package installer, pip.
+- Python 3.6 or higher
+- Streamlit
+- Loguru
+- Asyncio
+- A GPT provider (e.g., OpenAI, Gemini)
+
+## Installation
+
+Install the required packages using the Python package installer, pip:
+
+```bash
+pip install -r requirements.txt
+```
 
 ## Usage
-To utilize the AI Blog Metadata Generator module, follow these steps:
 
-## Generate Blog Title
+Follow these steps to utilize the AI Blog Metadata Generator module:
+
+### Generate Blog Title
+
 The module provides a function to create a blog title that is both SEO-optimized and engaging. This function ensures the title adheres to SEO best practices and avoids negative keywords.
 
-## Generate Meta Description
+### Generate Meta Description
+
 This functionality creates a compelling meta description for the blog content. The description is kept between 150-160 characters to ensure it meets SEO standards.
 
-## Generate Blog Tags
+### Generate Blog Tags
+
 The module suggests relevant and specific tags for the blog content. This helps in categorizing and improving the discoverability of the blog post.
 
-## Generate Blog Categories
+### Generate Blog Categories
+
 The module identifies the main topics and suggests the most relevant categories for the blog content. This function ensures that the blog is categorized appropriately for the target audience and taxonomy.
 
 ## Helper Functions
-The module includes helper functions to run the asyncio event loop within Streamlit. This ensures smooth and efficient operation of asynchronous tasks such as generating metadata.
+
+The module includes helper functions to run the asyncio event loop within Streamlit, ensuring smooth and efficient operation of asynchronous tasks such as generating metadata.
 
 By leveraging this module, users can enhance their blog posts with well-crafted metadata, improving their visibility and engagement in search engines.