From 1730335781d813f955e84d74ae1f0829d1665827 Mon Sep 17 00:00:00 2001 From: Benjamin Smith Date: Tue, 3 Sep 2024 12:43:35 +0200 Subject: [PATCH] udate readme --- cowswap-ai-plugin/README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/cowswap-ai-plugin/README.md b/cowswap-ai-plugin/README.md index 832e926..8a3010b 100644 --- a/cowswap-ai-plugin/README.md +++ b/cowswap-ai-plugin/README.md @@ -1,33 +1,31 @@ -# CoinGecko-AI +# CoWSwap-AI -cover_image +cover_image ## Description -CoinGecko-AI: Your intelligent companion for real-time cryptocurrency insights and price tracking provided Coingecko API's. +CoWSwap-AI: Your intelligent companion for real-time fair cryptocurrency trading with MEV-Protection! -CoinGecko-AI is a cutting-edge project that combines the power of artificial intelligence with real-time cryptocurrency data from CoinGecko. This innovative tool provides users with intelligent insights on crypto market data. CoinGecko-AI offers a unique and intuitive way to navigate the complex world of digital assets, making it an invaluable resource for both novice and experienced crypto enthusiasts. +Cowswap is a revolutionary decentralized trading platform that stands out by offering a unique, user-centric experience in the DeFi space. It leverages batch auctions to minimize front-running and slippage, ensuring fair and transparent trades for all users. Cowswap’s innovative approach allows traders to benefit from optimal pricing across multiple liquidity sources, making it a highly efficient and cost-effective solution for decentralized trading. With its focus on user protection and seamless trading, Cowswap is an invaluable tool for both beginners and seasoned traders looking to maximize their returns in the DeFi ecosystem. -[![Agent Demo](https://img.shields.io/badge/Demo-Visit%20Demo-orange)](https://wallet.bitte.ai/smart-actions/prompt/what%20can%20you%20help%20me%20with?mode=debug&agentId=coingecko-ai.vercel.app) -[![Demo](https://img.shields.io/badge/Demo-Visit%20Demo-brightgreen)](https://coingecko-ai.vercel.app/) -[![Deploy](https://img.shields.io/badge/Deploy-Deploy%20Now-blue)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FMintbase%2Ftemplates%2Ftree%2Fmain%2Fcoingecko-ai-plugin) +[![Agent Demo](https://img.shields.io/badge/Demo-Visit%20Demo-orange)](https://wallet.bitte.ai/smart-actions/prompt/what%20can%20you%20help%20me%20with?mode=debug&agentId=cowswap-ai.vercel.app) +[![Demo](https://img.shields.io/badge/Demo-Visit%20Demo-brightgreen)](https://cowswap-ai.vercel.app/) +[![Deploy](https://img.shields.io/badge/Deploy-Deploy%20Now-blue)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FMintbase%2Ftemplates%2Ftree%2Fmain%2Fcowswap-ai-plugin) **Tooling:** -[![Use Case](https://img.shields.io/badge/Use%20Case-Cryptocurrency%20Analysis,Price%20Prediction-blue)](#) -[![Tools](https://img.shields.io/badge/Tools-CoinGecko%20API,TensorFlow-blue)](#) +[![Use Case](https://img.shields.io/badge/Use%20Case-Cryptocurrency%20Quotes,Swaps,MEV%20Protection-blue)](#) +[![Tools](https://img.shields.io/badge/Tools-CoWSwap%20API-blue)](#) [![Framework](https://img.shields.io/badge/Framework-NextJS%2014-blue)](#) ## Project Walkthrough -detail_image - -CoinGecko-AI is built using Next.js 14 and exposes an API Reference using [Scalar](https://scalar.com/). +CoWSwap-AI is built using Next.js 14 and exposes an API Reference using [Scalar](https://scalar.com/). To run the project locally: -1. Clone this template from the repository tree: `git clone git clone --no-checkout https://github.com/Mintbase/templates.git && cd templates && git sparse-checkout set coingecko-ai-plugin && git checkout && cd coingecko-ai-plugin` +1. Clone this template from the repository tree: `git clone git clone --no-checkout https://github.com/Mintbase/templates.git && cd templates && git sparse-checkout set cowswap-ai-plugin && git checkout && cd cowswap-ai-plugin` 2. Install dependencies: `pnpm install` 3. Set up environment variables: Copy `.env.example` to `.env.local` and fill in your CoinGecko API key. 4. Run the development server: `pnpm run dev` @@ -35,16 +33,14 @@ To run the project locally: ## Deployment -To deploy CoinGecko-AI on Vercel: +To deploy CoWSwap-AI on Vercel: 1. Fork the repository to your GitHub account. 2. Sign up for a Vercel account if you haven't already. 3. Click the "Deploy" button above or go to https://vercel.com/new. 4. Select your forked repository. -5. Configure the following environment variables: - - `COINGECKO_API_KEY`: Your CoinGecko API key -6. Click "Deploy" and wait for the build to complete. +5. Click "Deploy" and wait for the build to complete. -Once deployed, you can access your CoinGecko-AI instance at the provided Vercel URL. You can customize the application by modifying the source code and pushing changes to your repository. Vercel will automatically redeploy your application with the latest changes. +Once deployed, you can access your CoWSwap-AI instance at the provided Vercel URL. You can customize the application by modifying the source code and pushing changes to your repository. Vercel will automatically redeploy your application with the latest changes. For any issues or questions regarding deployment, please refer to the Vercel documentation or open an issue in the project repository.