From d0218e3a2305a5ab83a1f923e88d2f92934a8978 Mon Sep 17 00:00:00 2001 From: chefjackson <116779127+chefjackson@users.noreply.github.com> Date: Mon, 25 Dec 2023 15:54:24 +0800 Subject: [PATCH] chore: Fix readme (#8665) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ## 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}` --- README.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ff583b56e2e28..785170b008b36 100644 --- a/README.md +++ b/README.md @@ -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` +
How to start @@ -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 ``` +
## `apps/aptos` +
How to start @@ -50,12 +55,15 @@ How to start ```sh pnpm dev:aptos ``` + ```sh pnpm build:aptos ``` +
## `apps/blog` +
How to start @@ -64,11 +72,15 @@ How to start ```sh pnpm dev:blog ``` + ```sh pnpm build:blog ``` +
+ ## `apps/games` +
How to start @@ -77,19 +89,22 @@ How to start ```sh pnpm dev:games ``` + ```sh pnpm build:games ``` -
+ ## 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. |