Skip to content

Commit cda7b85

Browse files
committed
updating changes to live
1 parent a225662 commit cda7b85

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@
66
</p>
77
</div>
88

9-
[Documentation](https://docs.rs/bitcoin/)
10-
119
Supports (or should support)
1210

13-
* De/serialization of Bitcoin protocol network messages
11+
* De/serialization of Coordinate protocol network messages
1412
* De/serialization of blocks and transactions
1513
* Script de/serialization
1614
* Private keys and address creation, de/serialization and validation (including full BIP32 support)
@@ -25,8 +23,8 @@ trustworthiness of each of your dependencies, including this one.
2523

2624
This library **must not** be used for consensus code (i.e. fully validating blockchain data). It
2725
technically supports doing this, but doing so is very ill-advised because there are many deviations,
28-
known and unknown, between this library and the Bitcoin Core reference implementation. In a
29-
consensus based cryptocurrency such as Bitcoin it is critical that all parties are using the same
26+
known and unknown, between this library and the Coordinate Core reference implementation. In a
27+
consensus based cryptocurrency such as Coordinate it is critical that all parties are using the same
3028
rules to validate data, and this library is simply unable to implement the same rules as Core.
3129

3230
Given the complexity of both C++ and Rust, it is unlikely that this will ever be fixed, and there
@@ -37,11 +35,6 @@ are no plans to do so. Of course, patches to fix specific consensus incompatibil
3735
16-bit pointer sizes are not supported and we can't promise they will be. If you care about them
3836
please let us know, so we can know how large the interest is and possibly decide to support them.
3937

40-
## Documentation
41-
42-
Currently can be found on [docs.rs/bitcoin](https://docs.rs/bitcoin/). Patches to add usage examples
43-
and to expand on existing docs would be extremely appreciated.
44-
4538

4639
## Minimum Supported Rust Version (MSRV)
4740

@@ -55,7 +48,7 @@ for the current list.
5548
Rust can be installed using your package manager of choice or [rustup.rs](https://rustup.rs). The
5649
former way is considered more secure since it typically doesn't involve trust in the CA system. But
5750
you should be aware that the version of Rust shipped by your distribution might be out of date.
58-
Generally this isn't a problem for `rust-bitcoin` since we support much older versions than the
51+
Generally this isn't a problem for `rust-coordinate` since we support much older versions than the
5952
current stable one (see MSRV section).
6053

6154
## Building
@@ -70,8 +63,8 @@ be usable without `std`. Both can be enabled without conflict.
7063
The library can be built and tested using [`cargo`](https://github.com/rust-lang/cargo/):
7164

7265
```
73-
git clone [email protected]:rust-bitcoin/rust-bitcoin.git
74-
cd rust-bitcoin
66+
git clone [email protected]:AnduroProject/rust-coordinate.git
67+
cd rust-coordinate
7568
cargo build
7669
```
7770

0 commit comments

Comments
 (0)