Skip to content

Commit 70f697d

Browse files
committed
Cleanup
1 parent b6013e2 commit 70f697d

1 file changed

Lines changed: 9 additions & 12 deletions

File tree

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Passcay
2+
[![Tests](https://github.com/uzyn/passcay/actions/workflows/test.yml/badge.svg)](https://github.com/uzyn/passcay/actions/workflows/test.yml)
23

34
![Passcay Logo](docs/passcay-logo.png)
45

56

6-
[![Tests](https://github.com/uzyn/passcay/actions/workflows/test.yml/badge.svg)](https://github.com/uzyn/passcay/actions/workflows/test.yml)
7-
8-
97
**Minimal**, **fast** and **secure** Passkey (WebAuthn) relying party (RP) library for Zig.
108

9+
Supports both Zig stable 0.14+ and nightly (0.15+).
10+
1111
## Features
1212

1313
- Passkey WebAuthn registration
@@ -18,11 +18,9 @@
1818

1919
## Dependencies
2020

21-
Compiles and tested on both Zig stable 0.14+ and nightly (0.15+).
22-
23-
Dynamically linked to system's OpenSSL for crypto verification.
21+
Dynamically linked to operating system's OpenSSL for crypto verification.
2422

25-
Works on Linux and macOS. Not yet on Windows.
23+
Works on Linux and macOS. Not on Windows due to OpenSSL dependency.
2624

2725
### Installation
2826

@@ -54,7 +52,6 @@ zig build
5452
zig build test --summary all
5553
```
5654

57-
5855
## Usage
5956

6057
### Registration
@@ -64,13 +61,13 @@ const passcay = @import("passcay");
6461
6562
const input = passcay.register.RegVerifyInput{
6663
.attestation_object = attestation_object,
67-
.client_data_json = client_data_json,
64+
.client_data_json = client_data_json,
6865
};
6966
7067
const expectations = passcay.register.RegVerifyExpectations{
71-
.challenge = challenge,
72-
.origin = "https://example.com",
73-
.rp_id = "example.com",
68+
.challenge = challenge,
69+
.origin = "https://example.com",
70+
.rp_id = "example.com",
7471
.require_user_verification = true,
7572
};
7673

0 commit comments

Comments
 (0)