Skip to content
This repository was archived by the owner on Dec 9, 2023. It is now read-only.

Commit 5527f1f

Browse files
committed
REAME improvements
1 parent 2e549cd commit 5527f1f

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Change Log
44
v0.2.1
55
------
66
- Fix to PSBT tweaking key representation for `i9n` integration interface
7+
- README improvements
78

89
v0.2.0
910
------

README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ a multi-threaded single process or as a set of managed threads within a
1919
wallet app.
2020

2121
For an easy test setup that allows to experience the node's capabilities, you
22-
can check out the [0.1 demo](doc/demo-0.1/).
22+
can check out the [demo](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/doc/demo-0.1/).
2323

2424
## Design
2525

2626
The node (as other nodes maitained by LNP/BP Standards Association and Pandora
2727
Core company subsidiaries) consists of multiple microservices, communicating
2828
with each other via LNP ZMQ RPC interface.
2929

30-
![Node architacture](doc/node_arch.jpeg)
30+
![Node architacture](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/doc/node_arch.jpeg)
3131

3232
The set of microservices representing node can run as either:
3333
1) single daemon process on desktop or a server;
@@ -54,18 +54,25 @@ for instance:
5454

5555
## Project organization & architecture
5656

57-
* [`src/api/`](src/api/) – LNP messages for all daemons used for message bus
58-
* [`src/bin/`](src/bin/) – binaries for daemons & CLI launching main process
59-
* [`src/cli/`](src/cli/) – CLAP-based command line API talking to message bus
60-
* [`src/i8n/`](src/i8n/) – functions exposed to FFI talking to message bus
57+
* [`src/api/`](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/src/api/)
58+
LNP messages for all daemons used for message bus
59+
* [`src/bin/`](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/src/bin/)
60+
binaries for daemons & CLI launching main process
61+
* [`src/cli/`](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/src/cli/)
62+
CLAP-based command line API talking to message bus
63+
* [`src/i8n/`](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/src/i8n/)
64+
functions exposed to FFI talking to message bus
6165
* `src/<name>/` – service/daemon-specific code:
62-
- [`src/stash/`](src/stash) – daemon managing RGB stash data and its storage;
66+
- [`src/stash/`](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/src/stash)
67+
daemon managing RGB stash data and its storage;
6368
you may configure it (with either config file, environment vars or
6469
command-line arguments) to use different forms of storage drivers;
65-
- [`src/contracts`](src/contracts) – daemons supporting high-level APIs for
70+
- [`src/contracts`](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/src/contracts)
71+
daemons supporting high-level APIs for
6672
working with different forms of RGB Schema: RGB-20 (fungible assets),
6773
RGB-21 (collectionables/NFTs) etc;
68-
- [`src/rgbd`](src/rgbd) – daemon orchestrating bootstrapping of stash and
74+
- [`src/rgbd`](https://github.com/LNP-BP/rgb-node/tree/v0.2.0/src/rgbd)
75+
daemon orchestrating bootstrapping of stash and
6976
contracts daemons
7077

7178
Each daemon (more correctly "microservice", as it can run as a thread, not

0 commit comments

Comments
 (0)