Skip to content

docs: improve README with setup & overview #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dark-Brain07 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve README with setup & overview #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down