docs: Update doc-site (#438)

* docs: Update doc-site * docs: Quick start
bnb-chain · Dec 20, 2023 · 075f9b5 · 075f9b5
1 parent eb8815b
commit 075f9b5
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 6 deletions.
diff --git a/doc-site/docs/getting-started/overview.md b/doc-site/docs/getting-started/overview.md
@@ -11,7 +11,7 @@ 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/greenfiled-file-handle](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/file-handle/README.md) | WASM module that handle file, such as `checksums` | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfiled-file-handle?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfiled-file-handle) |
+| [@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](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/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](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) |
 

diff --git a/doc-site/docs/getting-started/quick-start.mdx b/doc-site/docs/getting-started/quick-start.mdx
@@ -106,10 +106,18 @@ Creating a new Greenfield app in my-gnfd-app.
 
   <Image img={require('/img/quick-start/select-wallet.png')} width="500" />
 
-### 3. You can this page
+### 3. wallet
 
   <Image img={require('/img/quick-start/details.png')} width="500" />
 
 ### 4. Create a Bucket
 
+Create Bucket Tx:
+
   <Image img={require('/img/quick-start/create-bucket.png')} />
+
+### 5. Create a Object
+
+Creat Object Tx / Upload File / Download File:
+
+  <Image img={require('/img/quick-start/create-object.png')} />
diff --git a/doc-site/static/img/quick-start/create-object.png b/doc-site/static/img/quick-start/create-object.png
diff --git a/examples/nextjs/package.json b/examples/nextjs/package.json
@@ -13,7 +13,6 @@
   "dependencies": {
     "@bnb-chain/greenfield-cosmos-types": "0.4.0-alpha.25",
     "@bnb-chain/greenfield-js-sdk": "workspace:*",
-    "@bnb-chain/greenfiled-file-handle": "workspace:*",
     "@bnb-chain/reed-solomon": "workspace:*",
     "@cosmjs/encoding": "^0.32.0",
     "@cosmjs/proto-signing": "^0.32.0",

diff --git a/examples/nextjs/src/components/object/create/index.tsx b/examples/nextjs/src/components/object/create/index.tsx
@@ -2,7 +2,6 @@ import { client } from '@/client';
 import { getOffchainAuthKeys } from '@/utils/offchainAuth';
 import { ChangeEvent, useState } from 'react';
 import { useAccount } from 'wagmi';
-import { getCheckSumsWorker } from '@bnb-chain/greenfiled-file-handle';
 import { ReedSolomon } from '@bnb-chain/reed-solomon';
 
 export const CreateObject = () => {

diff --git a/examples/nodejs/package.json b/examples/nodejs/package.json
@@ -6,7 +6,6 @@
   "scripts": {},
   "dependencies": {
     "@bnb-chain/greenfield-js-sdk": "workspace:*",
-    "@bnb-chain/greenfiled-file-handle": "workspace:*",
     "@bnb-chain/reed-solomon": "workspace:*",
     "dotenv": "^16.0.3",
     "mime-types": "^2.1.35"

diff --git a/packages/file-handle/README.md b/packages/file-handle/README.md
@@ -1,4 +1,6 @@
-# Greenfield Files JS SDK
+# Greenfield Files JS SDK (Deprecated!)
+
+> Move to [reed-solomon](../reed-solomon/README.md)
 
 WASM module that handle file, such as `checksums` method.