Skip to content

Commit b91571b

Browse files
committed
added publish instructions to the readme
1 parent 58f1666 commit b91571b

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,13 @@ For more details refer to the individual packages:
1717

1818
For a detailed explanation on derivation paths refer to [learn me a bitcoin](https://learnmeabitcoin.com/technical/derivation-paths).
1919

20+
## Publishing
21+
22+
The `xpub-lib` and `xpub-cli` can be published to GitHub Packages by:
23+
1. Incrementing the version field within the package.json file within each package you want to publish.
24+
2. Creating a new tag with SemVer sytax (i.e. v0.0.1). Needs to match `v*`.
25+
3. Creating a new GitHub release using this tag. This will start the publish workflow.
26+
27+
The workflow will need to be approved by another user with write access before its executed. If published successfully, the packages will be published [here](https://github.com/orgs/swan-bitcoin/packages).
28+
2029
## License: [MIT](./LICENSE.md)

0 commit comments

Comments
 (0)