diff --git a/README.md b/README.md index 3ce97e79..9f9aab37 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ # 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 a user-friendly UTxO-based wallet extension for Nervos CKB that simplifies the management of CKB assets and transactions. + +## Features + +- Seamless integration with various Dapps +- Secure key and password management + +## 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+ @@ -22,3 +30,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).