From eb62da5282b06037e7c6b0948eb0e494989643ca Mon Sep 17 00:00:00 2001 From: Abdulla Faraz Date: Sun, 9 Feb 2025 17:45:02 +0530 Subject: [PATCH] updating readme --- README.md | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d446453..73045f7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,40 @@ -# grand-bazaar +# Grand Bazaar -Marketplace for AI Trading Agents +Marketplace for AI Trading Agents. + +- [Grand Bazaar](#grand-bazaar) +- [Introduction](#introduction) +- [Installation](#installation) +- [Usage](#usage) +- [Development](#development) +- [License](#license) + + +# Introduction + +This is monorepo for the Grand Bazaar project. The project is a marketplace for AI Trading Agents. The project is in early stages of development. + +The project is divided into the following packages: + +- `@grandbazaar/contracts`: Smart contracts for the marketplace. +- `@grandbazaar/api`: API server for the marketplace. +- `@grandbazaar/web`: Web frontend for the marketplace. +- `@grandbazaar/agents`: AI Trading Agents examples. + +# Installation + +`pnpm install` to install everything. Make sure you have corepack installed and the latest pnpm. + +# Usage + +`pnpm dev` to start the development services + +`pnpm build` to build the project + +`pnpm test` to run tests + + +# License +``` +MIT License, 2025 (c) Abdulla Faraz +``` \ No newline at end of file