Skip to content

Commit

Permalink
Add diagram to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cedoor authored Nov 5, 2023
1 parent e93a648 commit 7192ad6
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<source media="(prefers-color-scheme: light)" srcset="https://github.com/cedoor/zuauth/blob/main/example/public/icon.png">
<img width="50" alt="Semaphore icon" src="https://github.com/cedoor/zuauth/blob/main/example/public/icon.png">
</picture>
ZuAuth
Zuauth
</h1>
<p align="center">A simple toolkit designed to streamline the development of a zero-knowledge authentication system with Zupass tickets.</p>
</p>
Expand All @@ -25,6 +25,16 @@
| The repository includes the `zuauth` package and a commented example demonstrating how to create an authentication system using NextJS and IronSession. Use the [demo](https://zuauth.vercel.app/) and refer to the [tutorial](/#-tutorial) section below to understand how to integrate `zuauth` into your app. |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

```mermaid
sequenceDiagram
Zuauth-client->>Zuauth-server: getNonce()
Zuauth-server->>Zuauth-client: return <<nonce>>
Zuauth-client->>Zupass: requestPCD()
Zupass->>Zuauth-client: return <<ZKTicketPCD>>
Zuauth-client->>Zuauth-server: login()
Zuauth-server->>Zuauth-client: return <<cookie>>
```

## 🛠 Install

Install the `zuauth` package with npm:
Expand Down

0 comments on commit 7192ad6

Please sign in to comment.