Skip to content

Commit

Permalink
Document crate features
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronFeickert committed Jan 11, 2025
1 parent 1b3a505 commit 7d2e345
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@ let serde_bytes = serde_json::to_vec(&desc)?;
let borsh_bytes = borsh::to_vec(&desc)?;
```

## Features

| Feature | Default? | Description |
| :--- | :---: | :--- |
| `address` || Adds Bitcoin address and `ScriptBuf` functionality |
| `borsh` | | Adds descriptor serialization and deserialization via [`borsh`](https://borsh.io) |
| `serde` || Adds descriptor serialization and deserialization via [`serde`](https://serde.rs) |

## Rationale

There doesn't exist any general standard way to encode arbitrary relay-safe
Expand Down

0 comments on commit 7d2e345

Please sign in to comment.