Skip to content

Commit

Permalink
chore: Fix readme (#8665)
Browse files Browse the repository at this point in the history
<!--
Before opening a pull request, please read the [contributing
guidelines](https://github.com/pancakeswap/pancake-frontend/blob/develop/CONTRIBUTING.md)
first
-->


<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on adding build and start commands for different
applications (`web`, `aptos`, `blog`, `games`) and updates the packages
list.

### Detailed summary
- Added build and start commands for `web`, `aptos`, `blog`, `games`
applications.
- Updated the packages list with new packages: `smart-router`,
`multicall`, `v3-sdk`.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->
  • Loading branch information
chefjackson authored Dec 25, 2023
1 parent 054c7fc commit d0218e3
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ If you want to contribute, please refer to the [contributing guidelines](./CONTR
> Install dependencies using [pnpm](https://pnpm.io)
## `apps/web`

<details>
<summary>
How to start
Expand All @@ -28,20 +29,24 @@ pnpm i
```

start the development server

```sh
pnpm dev
```

build with production mode

```sh
pnpm build

# start the application after build
pnpm start
```

</details>

## `apps/aptos`

<details>
<summary>
How to start
Expand All @@ -50,12 +55,15 @@ How to start
```sh
pnpm dev:aptos
```

```sh
pnpm build:aptos
```

</details>

## `apps/blog`

<details>
<summary>
How to start
Expand All @@ -64,11 +72,15 @@ How to start
```sh
pnpm dev:blog
```

```sh
pnpm build:blog
```

</details>

## `apps/games`

<details>
<summary>
How to start
Expand All @@ -77,19 +89,22 @@ How to start
```sh
pnpm dev:games
```

```sh
pnpm build:games
```
</details>

</details>

## Packages

| Package | Description |
|---------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| [sdk](/packages/swap-sdk) | An SDK for building applications on top of Pancakeswap |
| [aptos-swap-sdk](/packages/aptos-swap-sdk) | Aptos version of Swap SDK |
| [swap-sdk-core](/packages/swap-sdk-core) | Swap SDK Shared code |
| [wagmi](/packages/wagmi) | Extension for [wagmi](https://github.com/wagmi-dev/wagmi), including bsc chain and binance wallet connector |
| [awgmi](/packages/awgmi) | Connect to Aptos with similar wagmi React hooks. |

| Package | Description |
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| [sdk](/packages/swap-sdk) | An SDK for building applications on top of Pancakeswap |
| [aptos-swap-sdk](/packages/aptos-swap-sdk) | Aptos version of Swap SDK |
| [swap-sdk-core](/packages/swap-sdk-core) | Swap SDK Shared code |
| [wagmi](/packages/wagmi) | Extension for [wagmi](https://github.com/wagmi-dev/wagmi), including bsc chain and binance wallet connector |
| [awgmi](/packages/awgmi) | Connect to Aptos with similar wagmi React hooks. |
| [smart-router](/packages/smart-router) | An SDK for getting best trade routes. |
| [multicall](/packages/multicall) | Enhanced multicall sdk to safely make multicalls within the gas limit. |
| [v3-sdk](/packages/v3-sdk) | An SDK for building applications on top of Pancakeswap V3. |

0 comments on commit d0218e3

Please sign in to comment.