Skip to content

Commit c3bd3c2

Browse files
committed
Add docs about implied pre-release
On `crates.io` our releases show up in yellow, implying they are pre-release versions. This is because of the `-` in our version number. Add docs explaining the version numbering to make explicit that the recent releases are not pre-releases.
1 parent ac44b72 commit c3bd3c2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ The project [rust-secp256k1](https://github.com/rust-bitcoin/rust-secp256k1) off
1818
This introduces a risk, since a difference between the two secp256k1 sources could break consensus with Bitcoin.
1919

2020

21+
## Version numbers
22+
23+
We use [slightly abuse] semantic versioning. The first `Major.Minor.Patch` number tracks the vendored Bitcoin Core code (see below), the second `Major.Minor.Patch` tracks this crate.
24+
For example, if we upgrade the Bitcoin Core code by a `Patch` version we also bump our `Patch` version.
25+
26+
One side effect of this is that `crates.io` shows our release versions in yellow as if they were pre-release versions, this is due to us using a `-` which, in semantic versioning, implies a pre-release version.
27+
28+
2129
## Bitcoin Core subtree
2230

2331
We use a git subtree to vendor the Bitcoin Core code. This can be seen from the following commits that were created using `git subtree add --prefix='depend/bitcoin' git@github.com:bitcoin/bitcoin.git v0.19.2 --squash`.

0 commit comments

Comments
 (0)