Skip to content

Commit 130da94

Browse files
authored
Update README.md
1 parent 7c1d93d commit 130da94

1 file changed

Lines changed: 102 additions & 38 deletions

File tree

README.md

Lines changed: 102 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,139 @@
1-
# 👋 Hey, I'm Plag
1+
# 🥭 MangoSwap
22

3-
**DeFi Builder | Crypto Author | Base Ecosystem**
3+
**Sweet Swaps on Base** 🔵
44

5-
Building the future of decentralized finance on [Base](https://base.org) 🔵
5+
[![Built on Base](https://img.shields.io/badge/Built%20on-Base-0052FF?style=flat&logo=ethereum&logoColor=white)](https://base.org)
6+
[![Live](https://img.shields.io/badge/Status-Live-success)](https://mangoswap.xyz)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8+
9+
A next-generation decentralized exchange built on Base, offering seamless token swaps with advanced trading features and a beautiful user experience.
10+
11+
🌐 **[Try MangoSwap →](https://mangoswap.xyz)**
12+
13+
---
14+
15+
## ✨ Features
16+
17+
### 🚀 Instant Swaps
18+
Trade any token on Base in seconds with minimal slippage and best price execution.
19+
20+
### 🎯 Limit Orders
21+
Set your target price and let orders execute automatically when the market hits your price—no need to watch charts all day.
22+
23+
### ⏰ Scheduled Swaps
24+
Automate recurring trades on a daily, weekly, or monthly schedule. Perfect for DCA strategies.
25+
26+
### ⛽ Gas-Free Transactions
27+
Powered by Coinbase Paymaster—trade without worrying about gas fees.
28+
29+
### 📦 Transaction Batching
30+
Built with EIP-5792 support for efficient batch transactions and improved UX.
631

732
---
833

9-
## 🚀 What I'm Building
34+
## 📸 Screenshots
35+
36+
<div align="center">
37+
<img src="docs/images/swap-interface.png" alt="Swap Interface" width="30%">
38+
<img src="docs/images/limit-orders.png" alt="Limit Orders" width="30%">
39+
<img src="docs/images/scheduled-trades.png" alt="Scheduled Trades" width="30%">
40+
</div>
41+
42+
*Clean, intuitive interface for seamless trading on Base*
1043

11-
### 🥭 [MangoSwap](https://mangoswap.xyz)
12-
A next-gen DEX on Base featuring instant swaps, limit orders, and scheduled trading with gas-free transactions.
44+
---
1345

14-
- ⚡ Instant token swaps with best price execution
15-
- 🎯 Automated limit orders
16-
- ⏰ Recurring scheduled swaps (DCA made easy)
17-
- ⛽ Gas-free trading via Coinbase Paymaster
18-
- 📦 EIP-5792 transaction batching
46+
## 🏗️ Built With
1947

20-
🔗 [Try it now →](https://mangoswap.xyz) | [GitHub →](https://github.com/plagtech/mangoswap)
48+
- **Frontend**: React, TypeScript, TailwindCSS
49+
- **Blockchain**: Solidity, Base (Ethereum L2)
50+
- **Web3**: Wagmi, Viem, RainbowKit
51+
- **Smart Contracts**: EIP-5792 (Batch Transactions)
52+
- **Sponsorship**: Coinbase Paymaster for gas-free txs
2153

2254
---
2355

24-
## 📚 Author
56+
## 📝 Smart Contracts
2557

26-
**"28 Tips for Creating Wealth in Crypto"**
58+
**Base Mainnet:**
59+
- Router Contract: [`0xb81fea65B45D743AB62a1A2B351f4f92fb1d4D16`](https://basescan.org/address/0xb81fea65B45D743AB62a1A2B351f4f92fb1d4D16)
2760

28-
Sharing insights and strategies from years of experience navigating the crypto markets since 2021.
61+
All contracts are verified on Basescan.
2962

3063
---
3164

32-
## 🛠️ Tech Stack
65+
## 🎯 Base Build Program
66+
67+
MangoSwap is part of the **Base Build** cohort, building the future of DeFi on Base alongside other innovative projects.
3368

69+
---
70+
71+
## 🚦 Getting Started
72+
73+
### Prerequisites
74+
```bash
75+
node >= 18.0.0
76+
npm or yarn
3477
```
35-
Blockchain: Solidity, Base, Ethereum
36-
Frontend: React, TypeScript, TailwindCSS
37-
Web3: Wagmi, Viem, RainbowKit
38-
Tools: EIP-5792, Coinbase Paymaster
78+
79+
### Installation
80+
```bash
81+
# Clone the repository
82+
git clone https://github.com/plagtech/mangoswap.git
83+
84+
# Navigate to project directory
85+
cd mangoswap
86+
87+
# Install dependencies
88+
npm install
89+
90+
# Start development server
91+
npm run dev
92+
```
93+
94+
### Environment Variables
95+
Create a `.env.local` file:
96+
```env
97+
NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID=your_project_id
98+
NEXT_PUBLIC_BASE_RPC_URL=https://mainnet.base.org
3999
```
40100

41101
---
42102

43-
## 🎯 Current Focus
103+
## 🤝 Contributing
104+
105+
Contributions are welcome! Feel free to open issues or submit pull requests.
44106

45-
- 🔨 Expanding MangoSwap features and liquidity
46-
- 📈 Growing Base ecosystem presence
47-
- 🤝 Building in the Base Build cohort
48-
- 📝 Creating educational DeFi content
107+
1. Fork the repository
108+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
109+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
110+
4. Push to the branch (`git push origin feature/AmazingFeature`)
111+
5. Open a Pull Request
49112

50113
---
51114

52-
## 📊 GitHub Stats
115+
## 📄 License
53116

54-
![GitHub Stats](https://github-readme-stats.vercel.app/api?username=plagtech&show_icons=true&theme=dark&hide_border=true&bg_color=0D1117)
117+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
55118

56119
---
57120

58-
## 🔗 Connect
121+
## 🔗 Links
59122

60-
[![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/lostpoet)
61-
[![Twitter](https://img.shields.io/badge/MangoSwap-FF6B00?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/mngoswp)
62-
[![Farcaster](https://img.shields.io/badge/Farcaster-855DCD?style=for-the-badge&logo=ethereum&logoColor=white)](https://farcaster.xyz/plag)
63-
[![Website](https://img.shields.io/badge/MangoSwap-0052FF?style=for-the-badge&logo=ethereum&logoColor=white)](https://mangoswap.xyz)
123+
- **Website**: [mangoswap.xyz](https://mangoswap.xyz)
124+
- **Twitter**: [@mngoswp](https://twitter.com/mngoswp)
125+
- **Farcaster**: [@plag](https://farcaster.xyz/plag)
126+
- **Base App**: plag.farcaster.eth
127+
- **Base**: [base.org](https://base.org)
64128

65129
---
66130

67-
<div align="center">
68-
<sub>Building on Base since 2024 🔵</sub>
69-
</div>
70-
- Website: https://mangoswap.xyz
71-
- Twitter: [@lostpoet](https://twitter.com/lostpoet)
131+
## 📬 Contact
132+
133+
Questions or feedback? Reach out on [Twitter](https://twitter.com/mngoswp) or [Farcaster](https://farcaster.xyz/plag).
72134

73135
---
74136

75-
Built with ❤️ on Base
137+
<div align="center">
138+
<sub>Built with ❤️ on Base</sub>
139+
</div>

0 commit comments

Comments
 (0)