Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
StringNick authored Sep 3, 2024
1 parent 20a02cc commit 1ad94f7
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,23 @@

Libraries and primitives for Bitcoin, written in Zig.

# Zig Official Package Manager

To install `bitcoin-zig`, you need to run the following command in your root folder with `build.zig`:

```bash
zig fetch --save git+https://github.com/zig-bitcoin/bitcoin-zig#f3af13008b088796697fc656e26d8c2ddf73dc18
```

where `f3af13008b088796697fc656e26d8c2ddf73dc18` is the commit hash.

Then, in your `build.zig`, you need to add our module:

```zig
const bitcoin_zig = b.dependency("bitcoin-zig", .{
.target = target,
.optimize = optimize,
});
exe.root_module.addImport("bitcoin", bitcoin_zig.module("bitcoin"));
```

0 comments on commit 1ad94f7

Please sign in to comment.