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.

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: new readme #175

Merged
merged 2 commits into from
Mar 30, 2023
Merged
Changes from all commits
Commits
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
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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+
Expand All @@ -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).