aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 74a32b339c6a6f61703fa85f2301b24adda87456 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# NKeys support for Zig

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![CI](https://github.com/rutgerbrf/zig-nkeys/actions/workflows/main.yml/badge.svg)](https://github.com/rutgerbrf/zig-nkeys/actions/workflows/main.yml)

Still a work in progress, things will definitely change!

Contains a tool called `znk` which is a clone of the [`nk` tool](https://github.com/nats-io/nkeys/tree/master/nk).

## Building

Zig master works at the time of writing.

Use `zig build` to build the library.
Use `zig build znk` to build the `znk` tool.

The `znk` tool can be run by using `zig build run-znk`.

Tests for the library can be run by using `zig build test`.
Tests for the `znk` tool can be run by using `zig build test-znk`.