From d379f3427fd180dd17588d7df5bacc24fec7e164 Mon Sep 17 00:00:00 2001
From: "sweep-ai[bot]" <128439645+sweep-ai[bot]@users.noreply.github.com>
Date: Sun, 14 Apr 2024 11:06:42 +0530
Subject: [PATCH] feat: Updated agents-api/README.md (#184)

Co-authored-by: sweep-ai[bot] <128439645+sweep-ai[bot]@users.noreply.github.com>
Co-authored-by: Diwank Singh Tomer <diwank.singh@gmail.com>
---
 agents-api/README.md | 46 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/agents-api/README.md b/agents-api/README.md
index 512514292..78d083d95 100644
--- a/agents-api/README.md
+++ b/agents-api/README.md
@@ -1,5 +1,49 @@
 # agents-api
 
+## Overview
+
+The `agents-api` project serves as the foundation of the agent management system, defining the structure and capabilities of the API that manages agents. It includes operations such as creating, updating, listing, and deleting agents, as well as managing documents and tools associated with these agents.
+
+## Modules
+
+### Models
+
+The `models` module encapsulates all data interactions with the CozoDB database, providing a structured way to perform CRUD operations and other specific data manipulations across various entities.
+
+### Routers
+
+The `routers` module handles HTTP routing for different parts of the application, directing incoming HTTP requests to the appropriate handler functions.
+
+### Dependencies
+
+This module contains components crucial for the operation of the agents-api, including authentication, developer identification, and custom exception handling.
+
+### Common Utilities
+
+The `utils` module offers a collection of utility functions designed to support various aspects of the application, including interactions with the Cozo API client, date and time operations, and custom JSON utilities.
+
+### Activities
+
+The `activities` module facilitates various activities related to agent interactions, such as memory management, generating insights from dialogues, and summarizing relationships.
+
+### Clients
+
+The `clients` module contains client classes and functions for interacting with various external services and APIs, providing a simplified interface for the rest of the application.
+
+### Workers
+
+This module is responsible for handling background tasks and jobs for the Agents API application, enhancing the application's performance and scalability.
+
+## Getting Started
+
+To set up the project for development:
+
+1. Clone the repository.
+2. Install dependencies.
+3. Run the application.
+
+This guide provides a brief overview for new contributors to get started with the project development.
+
 ## Schema
 
 ### Relation `agent_default_settings`
@@ -186,4 +230,4 @@
 │ 5 │ updated_at   │ False  │ Float  │ True        │
 │ 6 │ metadata     │ False  │ Json   │ True        │
 └───┴──────────────┴────────┴────────┴─────────────┘
-```
+```
\ No newline at end of file