Add README loading functionality and update README section in app.py

README.md

@@ -49,11 +49,8 @@ Hermes requires users to generate an MCP API key, which you can do right [here a
 
 ### ⚠️ Important! ⚠️
 
-Our Key Generation and Key Validation server is Deployed on Render and spins down if unused for extended periods of time.
-It may take up to 60 seconds for requests to go through if you are the first person on the site in a while. If requests or the website time 
-out while loading, please try again after a minute or two. We plan on moving off of Render soon! 
-
-Call results and configurations will be deleted 14 days after the last call to the API. This is to ensure that the database does not get too large and to protect user privacy.
+- Call results and configurations will be deleted 14 days after the last call to the API. This is to ensure that the database does not get too large and to protect user privacy.
+- Render is used to host the backend, which means that the server will go to sleep after a period of inactivity. This may cause a delay in the first request after a period of inactivity, but subsequent requests should be faster. If it does not work, try refreshing the page/the agent.
 
 ## Complete Workflow Process
 

app.py

@@ -1,4 +1,5 @@
 import gradio as gr
+import os
 from api_monitor import (
     validate_api_configuration,
     activate_monitoring,
@@ -6,6 +7,27 @@ from api_monitor import (
 )
 
 
+def load_readme():
+    """Load and return the README content."""
+    try:
+        readme_path = os.path.join(os.path.dirname(__file__), "README.md")
+        with open(readme_path, "r", encoding="utf-8") as f:
+            content = f.read()
+        # Remove the YAML front matter for cleaner display
+        if content.startswith("---"):
+            lines = content.split("\n")
+            yaml_end = -1
+            for i, line in enumerate(lines[1:], 1):
+                if line.strip() == "---":
+                    yaml_end = i
+                    break
+            if yaml_end > 0:
+                content = "\n".join(lines[yaml_end + 1 :])
+        return content
+    except Exception as e:
+        return f"Error loading README: {str(e)}"
+
+
 # API Validation Tab
 validation_tab = gr.Interface(
     fn=validate_api_configuration,
@@ -161,10 +183,20 @@ retrieve_tab = gr.Interface(
     ],
 )
 
+# README Tab
+readme_tab = gr.Interface(
+    fn=load_readme,
+    inputs=[],
+    outputs=gr.Markdown(label="Documentation/Readme", value=load_readme()),
+    title="Documentation & Guide",
+    description="Complete documentation and usage guide for Hermes API Monitoring tool. This includes setup instructions, workflow examples, and troubleshooting information.",
+    flagging_mode="auto",
+)
+
 # Create tabbed interface
 demo = gr.TabbedInterface(
-    [validation_tab, scheduler_tab, retrieve_tab],
-    ["Validate & Store", "Activate Scheduler", "Retrieve Data"],
+    [validation_tab, scheduler_tab, retrieve_tab, readme_tab],
+    ["Validate & Store", "Activate Scheduler", "Retrieve Data", "Documentation"],
     title="Hermes - Automated Asynchronous REST API Monitoring",
 )