Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update doc-site #438

Merged
merged 2 commits into from
Dec 20, 2023
Merged

docs: Update doc-site #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a139c2
docs: Update doc-site
rrr523 Dec 19, 2023
87a0b0c
docs: Quick start
rrr523 Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc-site/docs/getting-started/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |

Expand Down
10 changes: 9 additions & 1 deletion doc-site/docs/getting-started/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')} />
Binary file added doc-site/static/img/quick-start/create-object.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion examples/nextjs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 0 additions & 1 deletion examples/nextjs/src/components/object/create/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = () => {
Expand Down
1 change: 0 additions & 1 deletion examples/nodejs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 3 additions & 1 deletion packages/file-handle/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Loading