Skip to content

Commit

Permalink
docs: Update REAMDE (#495)
Browse files Browse the repository at this point in the history
  • Loading branch information
rrr523 authored Mar 11, 2024
1 parent b96eabb commit 98ee8e5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ A Greenfield JS SDK is an easy-to-use tool designed to help developers build dec

You can find some package documentation below:

| Package | Description | Version |
| Package | Description | Version |
| --- | --- | --- |
| [@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/greenfield-zk-crypto](./packages/zk-crypto/README.md) | WASM module about sign crypto | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-zk-crypto?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfield-zk-crypto) |
| [@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) |

## Online Examples
Expand All @@ -27,7 +26,7 @@ You can use [`create-gnfd-app`](./packages/create-gnfd-app/README.md) to create
> npx @bnb-chain/create-gnfd-app
```

![](./packages/create-gnfd-app/example.gif)
![quick start example](./packages/create-gnfd-app/example.gif)

## Supported JS environments

Expand All @@ -44,6 +43,7 @@ You can use [`create-gnfd-app`](./packages/create-gnfd-app/README.md) to create
```

2. Build packages:

```bash
> pnpm -F "@bnb-chain/**" build
```
Expand Down
4 changes: 3 additions & 1 deletion packages/zk-crypto/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Zk Crypto
# Zk Crypto (Deprecated!)

> Using ed25519 since `1.3.0`
NPM Wrap for [zkbnb-js-sdk](https://github.com/bnb-chain/zkbnb-js-sdk).

Expand Down

0 comments on commit 98ee8e5

Please sign in to comment.