Skip to content

Commit

Permalink
docs: Update README (#547)
Browse files Browse the repository at this point in the history
  • Loading branch information
rrr523 authored May 20, 2024
1 parent e07f5c8 commit 19da622
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ You can find some package documentation below:
| [@bnb-chain/create-gnfd-app](./packages/create-gnfd-app/README.md) | Create Greenfield App Quickly | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fcreate-gnfd-app?color=blue)](https://www.npmjs.com/package/@bnb-chain/create-gnfd-app) |
| [@bnb-chain/bsc-cross-greenfield-sdk](./packages/bsc-cross-sdk/README.md) | Execute tx in BSC | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fbsc-cross-greenfield-sdk?color=blue)](https://www.npmjs.com/package/@bnb-chain/bsc-cross-greenfield-sdk) |

## Playground
<!-- ## Playground
* [Browser](https://codesandbox.io/p/github/rrr523/greenfield-nextjs-template/main?import=true)
* [Browser](https://codesandbox.io/p/github/rrr523/greenfield-nextjs-template/main?import=true) -->
<!-- TODO: after upgrade SDK version -->
<!-- * [Nodejs](https://codesandbox.io/p/devbox/nodejs-greenfield-js-sdk-demo-wd5zft) -->

## Online Examples
## Online Examples / Playground

* [Nextjs](https://codesandbox.io/p/github/rrr523/greenfield-nextjs-template/main?import=true)
* [Vite](https://codesandbox.io/p/github/rrr523/greenfield-vite-template/main)
* [Create React App](https://codesandbox.io/p/github/rrr523/greenfield-cra-template/main?import=true)
* [Nextjs](https://stackblitz.com/github/rrr523/greenfield-nextjs-template)
* [Vite](https://stackblitz.com/github/rrr523/greenfield-vite-template)
* [Create React App](https://stackblitz.com/github/rrr523/greenfield-cra-template)

## Quick Start

Expand Down
File renamed without changes.
15 changes: 8 additions & 7 deletions doc-site/docs/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,22 @@ You can find some package documentation below:

| Package | Description | Version |
| --- | --- | --- |
| [@bnb-chain/greenfield-js-sdk](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/js-sdk/README.md) | A client library for Greenfield Chain | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-js-sdk?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfield-js-sdk) |
| [@bnb-chain/reed-solomon](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/reed-solomon) | calculate file's `checksums` | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Freed-solomon?color=blue)](https://www.npmjs.com/package/@bnb-chain/reed-solomon) |
| [@bnb-chain/create-gnfd-app](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/create-gnfd-app/README.md) | Create Greenfield App Quickly | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fcreate-gnfd-app?color=blue)](https://www.npmjs.com/package/@bnb-chain/create-gnfd-app) |
| [@bnb-chain/greenfield-js-sdk](./packages/js-sdk/README.md) | A client library for Greenfield Chain | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-js-sdk?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfield-js-sdk) |
| [@bnb-chain/reed-solomon](./packages/reed-solomon/README.md) | calculate file's `checksums` | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Freed-solomon?color=blue)](https://www.npmjs.com/package/@bnb-chain/reed-solomon) |
| [@bnb-chain/create-gnfd-app](./packages/create-gnfd-app/README.md) | Create Greenfield App Quickly | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fcreate-gnfd-app?color=blue)](https://www.npmjs.com/package/@bnb-chain/create-gnfd-app) |
| [@bnb-chain/bsc-cross-greenfield-sdk](./packages/bsc-cross-sdk/README.md) | Execute tx in BSC | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fbsc-cross-greenfield-sdk?color=blue)](https://www.npmjs.com/package/@bnb-chain/bsc-cross-greenfield-sdk) |

## Playground

* [Browser](https://codesandbox.io/p/github/rrr523/greenfield-nextjs-template/main?import=true)
<!-- TODO: after upgrade SDK version -->
<!-- * [Nodejs](https://codesandbox.io/p/devbox/nodejs-greenfield-js-sdk-demo-wd5zft) -->

## Online Examples
## Online Examples / Playground

* [Nextjs](https://codesandbox.io/p/github/rrr523/greenfield-nextjs-template/main?import=true)
* [Vite](https://codesandbox.io/p/github/rrr523/greenfield-vite-template/main)
* [Create React App](https://codesandbox.io/p/github/rrr523/greenfield-cra-template/main?import=true)
* [Nextjs](https://stackblitz.com/github/rrr523/greenfield-nextjs-template)
* [Vite](https://stackblitz.com/github/rrr523/greenfield-vite-template)
* [Create React App](https://stackblitz.com/github/rrr523/greenfield-cra-template)

## Supported JS environments

Expand Down

0 comments on commit 19da622

Please sign in to comment.