diff --git a/README.md b/README.md index 45e9531..7ca5466 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ ## Getting Started -To get started with this project locally, follow the instructions below. +This repository is a fork of the official PancakeSwap developer documentation and starter project. +It provides tools and resources to help developers build on top of the PancakeSwap ecosystem. :contentReference[oaicite:1]{index=1} -First, install bun.js if you haven't already: +## 🚀 What Is This + +The **pancake‑developer** repository includes: + +- 🧩 Starter project configuration +- 📄 Developer docs and examples +- ⚙️ Frontend components and utilities +- 🛠️ Bun & TypeScript setup + +> This repo is a great starting point if you want to contribute to PancakeSwap tools or build your own Pancake‑based application. :contentReference[oaicite:2]{index=2} + +--- + +### Requirements + +Make sure you have **Bun** installed: ```bash -curl -fsSL https://bun.sh/install | bash -``` +bun --version + + +First, install bun.js if you haven't already: and the dependencies: