From 98ee8e5fbdb0fb089e417a4d238eab1def82e7c8 Mon Sep 17 00:00:00 2001
From: rk <59029880+rrr523@users.noreply.github.com>
Date: Mon, 11 Mar 2024 18:04:34 +0800
Subject: [PATCH] docs: Update REAMDE (#495)

---
 README.md                    | 6 +++---
 packages/zk-crypto/README.md | 4 +++-
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 16319f3c..c517a9f5 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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
 
@@ -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
 ```
diff --git a/packages/zk-crypto/README.md b/packages/zk-crypto/README.md
index 0ab7a576..d10b0054 100644
--- a/packages/zk-crypto/README.md
+++ b/packages/zk-crypto/README.md
@@ -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).