Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
coderofstuff committed Feb 5, 2024
1 parent 2a208a4 commit 1dc8de9
Showing 1 changed file with 18 additions and 21 deletions.
39 changes: 18 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,31 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# KasVault

## Getting Started
KasVault is a simple frontend interface for your Ledger device.

First, run the development server:
## Official User Guide

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
See the official user guide at: https://wiki.kaspa.org/en/kasvault-basic-guide

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Compatible Browsers

You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.
The browser needs to support WebUSB/WebHID so it can interact with the Ledger device. These are the known compatible browsers:
- Edge
- Chrome

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Development and Running Locally

## Learn More
You will need [NodeJS](https://nodejs.org/en) to run this locally

To learn more about Next.js, take a look at the following resources:
First, run the development server:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
```bash
npm run dev
```

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
Open [http://localhost:3000](http://localhost:3000) with your browser to start using or developing KasVault locally.

## Deploy on Vercel
## FAQ

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
### Are my funds safe with KasVault?

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
Yes, but to be clear KasVault itself does not store your Kaspa. Your Kaspa is also not stored in the Ledger device as well. When you send kaspa to the address you generate with KasVault, it is stored on the blockdag as a UTXO.

0 comments on commit 1dc8de9

Please sign in to comment.