Skip to content

Commit d794baf

Browse files
committed
Improve Readme
1 parent 66b0f13 commit d794baf

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,29 @@ Terminal client for p2p using Mostro protocol.
1616

1717
To compile on Ubuntu/Pop!\_OS, please install [cargo](https://www.rust-lang.org/tools/install), then run the following commands:
1818

19-
```
19+
```bash
2020
$ sudo apt update
2121
$ sudo apt install -y cmake build-essential pkg-config
2222
```
2323

2424
## Install
2525

26-
```
26+
```bash
2727
$ git clone https://github.com/MostroP2P/mostrui.git
2828
$ cd mostrui
29+
```
30+
31+
### Settings
32+
33+
Make sure that you have the following settings in your `~/.mostrui/settings.toml` file, you can find an example of the settings file in `settings.tpl.toml`, so you can copy it and modify it to your needs.
34+
35+
```toml
36+
mostro_pubkey = "0000000000000000000000000000000000000000000000000000000000000000"
37+
relays = ["wss://relay.mostro.network", "wss://nostr.bilthon.dev"]
38+
```
39+
40+
### Run
41+
42+
```bash
2943
$ cargo run
3044
```

settings.tpl.toml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# Mostro pubkey, it can be hex or npub
22
mostro_pubkey = "0000000000000000000000000000000000000000000000000000000000000000"
3+
# Relays to connect to
34
relays = ["wss://relay.mostro.network", "wss://nostr.bilthon.dev"]

0 commit comments

Comments
 (0)