Skip to content

Commit

Permalink
Update hyperlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
SnorlaxAssist authored Jun 14, 2024
1 parent d364737 commit 0e00caf
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Unofficial Zig bindings for [LZ4](https://github.com/lz4/lz4).
## Features
- LZ4 & LZ4Frame Compression
- LZ4 & LZ4Frame Decompression
- [Encoder](https://snorlaxassist.github.io/zig-lz4/#zig-lz4.Encoder) (based on LZ4Frame)
- [Decoder](https://snorlaxassist.github.io/zig-lz4/#zig-lz4.Encoder) (based on LZ4Frame)
- [Encoder](https://snorlaxassist.github.io/zig-lz4/#docs.Encoder) (based on LZ4Frame)
- [Decoder](https://snorlaxassist.github.io/zig-lz4/#docs.Encoder) (based on LZ4Frame)

## Installation
1. Add dependency to `build.zig.zon`
Expand All @@ -30,7 +30,7 @@ exe.addModule("lz4", ziglz4.module("zig-lz4"));

## Examples

### File [Encoder](https://snorlaxassist.github.io/zig-lz4/#zig-lz4.Encoder)
### File [Encoder](https://snorlaxassist.github.io/zig-lz4/#docs.Encoder)
```zig
const std = @import("std");
Expand Down Expand Up @@ -63,7 +63,7 @@ const sizeHintHeader : [4]u8 = @bitCast(@as(u32, @intCast(input.len)));
try std.fs.cwd().writeFile("compressedFile", fileOutput);
```

### File [Decoder](https://snorlaxassist.github.io/zig-lz4/#zig-lz4.Encoder)
### File [Decoder](https://snorlaxassist.github.io/zig-lz4/#docs.Encoder)
```zig
const std = @import("std");
Expand All @@ -85,7 +85,7 @@ defer allocator.free(decompressed);
std.debug.print("Decompressed: {s}\n", .{decompressed});
```

### Simple [Compression & Decompression](https://snorlaxassist.github.io/zig-lz4/#zig-lz4.Standard)
### Simple [Compression & Decompression](https://snorlaxassist.github.io/zig-lz4/#docs.Standard)
```zig
const std = @import("std");
Expand All @@ -104,4 +104,4 @@ const decompressed = try Standard.decompress(allocator, compressed, input.len);
defer allocator.free(decompressed);
std.debug.print("Decompressed: {s}\n", .{decompressed});
```
```

0 comments on commit 0e00caf

Please sign in to comment.