From 0b797b988f50f8d57c231539a916f240d8a5f56f Mon Sep 17 00:00:00 2001 From: zhangyouxin Date: Wed, 29 Mar 2023 22:37:49 +0800 Subject: [PATCH 1/2] docs: new readme --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3ce97e79..b4dd5a24 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ # Nexus -An UTxO friendly wallet extension for CKB - ![coverage](https://img.shields.io/codecov/c/github/ckb-js/nexus) ![build](https://img.shields.io/github/actions/workflow/status/ckb-js/nexus/test.yaml) +Nexus is an UTxO friendly wallet chrome extension for the CKB blockchain. It is designed to serve both DApp developers and end users. + +## Usage + +For end users, Nexus Wallet is a browser extension that can be installed on Chrome. User can create/import a wallet, switch connected network, sign data/transaction, and interact with DApps. To download the latest version of Nexus Wallet, please head over to the [release page](https://github.com/ckb-js/nexus/releases). + +For DApp developers, Nexus is a library that can be used to interact with the CKB blockchain. The instructions below can help you get started with Nexus. + +## Examples + +For DApp developers, we have provided some use cases for Nexus, such as enable wallet, transfer CKBs, etc. Please check it out at the [examples directory](https://github.com/ckb-js/nexus/tree/main/examples). + ## Quick Start - Node.js 18+ @@ -22,3 +32,12 @@ npm run test # drop the "build" folder into the chrome://extensions to start npm start ``` + +## Documentation + +- [API Reference](https://github.com/ckb-js/nexus/blob/main/docs/rpc.md) +- [Guide for End Users](https://github.com/ckb-js/nexus/blob/main/docs/user-guide.md) +- [Guide for Developers](https://github.com/ckb-js/nexus/blob/main/docs/get-started.md) +- [FAQs](https://github.com/ckb-js/nexus/blob/main/docs/faq.md) + +To read more about Nexus, you can also check out the [docs directory](https://github.com/ckb-js/nexus/blob/main/docs). From 833d6dfa658e9302dca40c4801b280bd2481b7e7 Mon Sep 17 00:00:00 2001 From: Shinya Date: Thu, 30 Mar 2023 16:19:42 +0800 Subject: [PATCH 2/2] Update README.md Co-authored-by: Yonghui Lin --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b4dd5a24..9f9aab37 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,16 @@ ![coverage](https://img.shields.io/codecov/c/github/ckb-js/nexus) ![build](https://img.shields.io/github/actions/workflow/status/ckb-js/nexus/test.yaml) -Nexus is an UTxO friendly wallet chrome extension for the CKB blockchain. It is designed to serve both DApp developers and end users. +Nexus is a user-friendly UTxO-based wallet extension for Nervos CKB that simplifies the management of CKB assets and transactions. -## Usage +## Features -For end users, Nexus Wallet is a browser extension that can be installed on Chrome. User can create/import a wallet, switch connected network, sign data/transaction, and interact with DApps. To download the latest version of Nexus Wallet, please head over to the [release page](https://github.com/ckb-js/nexus/releases). +- Seamless integration with various Dapps +- Secure key and password management -For DApp developers, Nexus is a library that can be used to interact with the CKB blockchain. The instructions below can help you get started with Nexus. - -## Examples - -For DApp developers, we have provided some use cases for Nexus, such as enable wallet, transfer CKBs, etc. Please check it out at the [examples directory](https://github.com/ckb-js/nexus/tree/main/examples). +## Try it Out +You can download the latest wallet from the GitHub [release](https://github.com/ckb-js/nexus/releases) to try it out, and we've provided a [demo](https://demo-nexus.vercel.app/) preview of the Nexus features ## Quick Start - Node.js 18+