Skip to content

Commit

Permalink
more readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ultd committed May 17, 2023
1 parent de49f5b commit 52a991f
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 @@ -111,7 +111,10 @@ pub fn main() !void {
<details>
<summary><code>encode</code> - Base58 Encodes a `[]u8` into an `dest` buffer passed and returns bytes written to buffer.</summary>

<br/>
The `dest` buffer written to needs to be properly sized. Base58 encoding is a variable length encoder therefore you should allocate extra and then resize if needed afterwards. Below is an example.
<br/>
<br/>

**Example**

Expand Down Expand Up @@ -167,6 +170,11 @@ pub fn main() !void {
<details>
<summary><code>decode</code> - Decodes a base58 encoded string into `dest` buffer and returns number of bytes written.</summary>

<br/>
The `dest` buffer written to needs to be properly sized. Base58 encoding is a variable length encoder therefore you should allocate extra and then resize if needed afterwards. Below is an example.
<br/>
<br/>

**Example**

```zig
Expand Down

0 comments on commit 52a991f

Please sign in to comment.