Skip to content

Commit faace36

Browse files
committed
chore: fix README
1 parent 9d24c24 commit faace36

File tree

2 files changed

+22
-19
lines changed

2 files changed

+22
-19
lines changed

MANIFEST.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Type: Library
33
Kind: Free software
44
License: Apache-2.0
55
Language: Rust
6-
Compiler: 1.75
6+
Compiler: 1.76
77
Author: Maxim Orlovsky
88
Maintained: LNP/BP Standards Association, Switzerland
99
Maintainers:

README.md

+21-18
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# RGB wallet & standard libraries for smart contracts on Bitcoin & Lightning
22

3-
![Build](https://github.com/RGB-WG/rgb-wallet/workflows/Build/badge.svg)
4-
![Tests](https://github.com/RGB-WG/rgb-wallet/workflows/Tests/badge.svg)
5-
![Lints](https://github.com/RGB-WG/rgb-wallet/workflows/Lints/badge.svg)
6-
[![codecov](https://codecov.io/gh/RGB-WG/rgb-wallet/branch/master/graph/badge.svg)](https://codecov.io/gh/RGB-WG/rgb-wallet)
3+
![Build](https://github.com/RGB-WG/rgb-std/workflows/Build/badge.svg)
4+
![Tests](https://github.com/RGB-WG/rgb-std/workflows/Tests/badge.svg)
5+
![Lints](https://github.com/RGB-WG/rgb-std/workflows/Lints/badge.svg)
6+
[![codecov](https://codecov.io/gh/RGB-WG/rgb-std/branch/master/graph/badge.svg)](https://codecov.io/gh/RGB-WG/rgb-std)
77

8-
[![crates.io](https://img.shields.io/crates/v/rgb-wallet)](https://crates.io/crates/rgb-wallet)
9-
[![Docs](https://docs.rs/rgb-wallet/badge.svg)](https://docs.rs/rgb-wallet)
8+
[![crates.io](https://img.shields.io/crates/v/rgb-std)](https://crates.io/crates/rgb-std)
9+
[![Docs](https://docs.rs/rgb-std/badge.svg)](https://docs.rs/rgb-std)
1010
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
11-
[![Apache-2 licensed](https://img.shields.io/crates/l/rgb-wallet)](./LICENSE)
11+
[![Apache-2 licensed](https://img.shields.io/crates/l/rgb-std)](./LICENSE)
1212

1313
RGB is confidential & scalable client-validated smart contracts for Bitcoin &
1414
Lightning. To learn more about RGB please check [RGB blueprint][Blueprint] and
1515
[RGB FAQ][FAQ] websites.
1616

17-
RGB wallet standard library provides non-consensus-critical high-level API for
18-
RGB applications. It is based on [RGB Core Lib][Core], implementing validation
17+
RGB wallet standard library provides non-consensus-critical high-level API for
18+
RGB applications. It is based on [RGB Core Lib][Core], implementing validation
1919
and consensus rules for RGB smart contracts.
2020

2121
The development of the project is supported and managed by [LNP/BP Standards
@@ -28,6 +28,7 @@ and this library will accept only bugfixes; i.e. it will be ossified by
2828
requiring consensus ACK for the new changes across the large set of maintainers.
2929

3030
The current list of the projects based on the library include:
31+
3132
* [RGB Node][RGB Node]: standalone & embeddable node for running RGB.
3233
* [MyCitadel Node][MyCitadel Node]: wallet node providing RGB smart contract
3334
functionality integrated with Lightning network, bitcoin blockchain indexers,
@@ -40,15 +41,7 @@ The library can be integrated into other rust projects via `Cargo.toml`
4041
`[dependencies]` section:
4142

4243
```toml
43-
rgb-wallet = "0.10.0"
44-
```
45-
46-
If the library will be used for wallet applications and work with PSBT files,
47-
than use `wallet` feature, which is non-default:
48-
49-
```toml
50-
[dependencies]
51-
rgb-wallet = { version = "0.8", features = ["wallet"] }
44+
rgb-std = "0.11.0"
5245
```
5346

5447
For serialization purposes library provides `serde` feature, which is turned off
@@ -70,13 +63,23 @@ See [LICENCE](LICENSE) file.
7063

7164

7265
[LNPBPs]: https://github.com/LNP-BP/LNPBPs
66+
7367
[Association]: https://lnp-bp.org
68+
7469
[Blueprint]: https://rgb.network
70+
7571
[FAQ]: https://rgbfaq.com
72+
7673
[Foundation]: https://github.com/LNP-BP/client_side_validation
74+
7775
[BP]: https://github.com/BP-WG/bp-core
76+
7877
[RGB Std]: https://github.com/RGB-WG/rgb-std
78+
7979
[RGB Node]: https://github.com/RGB-WG/rgb-node
80+
8081
[Max]: https://github.com/dr-orlovsky
82+
8183
[Todd]: https://petertodd.org/
84+
8285
[Zucco]: https://giacomozucco.com/

0 commit comments

Comments
 (0)