Skip to content

Commit 71e555a

Browse files
committed
docs: update README
1 parent ad7eceb commit 71e555a

1 file changed

Lines changed: 30 additions & 6 deletions

File tree

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
This crate implements an experimental GUI wallet prototype for [neptune cash](https://neptune.cash). This is a binary/application crate, built on the Dioxus framework.
44

5-
## WARNING: EXPERIMENTAL!
6-
7-
This crate is in an early, very rough prototype state. Everything is subject to change, or it could be abandoned altogether.
8-
95
## Naming
106

117
The "proto" in `neptune-proton` refers to the prototype nature of this wallet.
@@ -21,6 +17,29 @@ It can be thought of as a GUI dashboard for neptune-core.
2117
This means that neptune-proton is an interface for neptune-core's built-in
2218
wallet. neptune-proton does not generate any wallet keys of its own.
2319

20+
## Quick Start
21+
22+
1. Install neptune-core, if you haven't already.
23+
24+
https://github.com/Neptune-Crypto/neptune-core
25+
26+
2. Run neptune-core.
27+
28+
3. Download neptune-proton binary for your platform from
29+
30+
https://github.com/Neptune-Crypto/neptune-proton/releases/latest
31+
32+
4. Install neptune-proton using your operating system's package manager.
33+
34+
5. run neptune-proton.
35+
36+
If everything is correct it should automatically connect to neptune-core and
37+
display your wallet.
38+
39+
See the Environment Variables section below if you should need to modify the
40+
RPC port or other settings.
41+
42+
2443
## Project Goals
2544

2645
The prototype has a few primary objectives:
@@ -36,7 +55,7 @@ The prototype has a few primary objectives:
3655
4. Provide a starting point for wallet developers to launch from for more
3756
advanced wallets.
3857

39-
5. Eventually provide a functional, if simple, GUI wallet/dashboard for
58+
5. Provide a functional, if simple, GUI wallet/dashboard for
4059
the neptune-cash community to interact with neptune-core.
4160

4261
## Non Goals (at this time)
@@ -48,13 +67,18 @@ The prototype has a few primary objectives:
4867

4968
## Status
5069

70+
As of 2025-11-28:
71+
72+
* windows, mac, and linux desktop binaries are available in `Releases` (v0.1.2)
73+
* web (wasm) build works, must build from source.
74+
5175
As of 2025-11-18:
5276

5377
* fetching price data from goingecko and coinpaprika.
5478
* displaying and entering amounts in many national currencies.
5579
* generation and scanning of animated QR codes.
5680
* export and import of animated QR code files.
57-
* builds for web and desktop (linux, windows, mac coming soon)
81+
* builds for web and desktop (linux) windows, mac coming soon.
5882
* mempool screen works
5983
* history screen works
6084
* a new peers screen works

0 commit comments

Comments
 (0)