Skip to content

Commit

Permalink
Added blog links and change from npm to yarn
Browse files Browse the repository at this point in the history
  • Loading branch information
Metachaser24 committed Feb 16, 2024
1 parent f084af8 commit 622cbf1
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 19 deletions.
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,23 @@ Visit our [docs](/docs/README.md) to learn more about the project and how to bui

Try here: [https://twitter.prove.email/](https://twitter.prove.email/)

You can fork the project as a starting point for your own ZK-Email application.
You can fork the project as a starting point for your own ZK-Email application.

Moreover, for those interested in creating the Twitter circuit from scratch, our [Proof of Twitter guide](https://prove.email/blog/twitter) offers a step-by-step tutorial on utilizing our SDKs for circuit construction.

## Installation
To get started with the ZK Email Verifier, follow these steps:
1. Install the `@zk-email/helpers` package:
```shell
npm install @zk-email/helpers
yarn add @zk-email/helpers
```
2. Install the `@zk-email/contracts` package:
```shell
npm install @zk-email/contracts
yarn add @zk-email/contracts
```
3. Install the `@zk-email/circuits` package:
```shell
npm install @zk-email/circuits
yarn add @zk-email/circuits
```
## Package Overviews

Expand Down Expand Up @@ -63,18 +65,9 @@ packages/
helpers # Helper files for DKIM verification, input generation, etc.
```
## Contributors 💡
We will award $50 for every successfully merged PR that resolves any [open issue](https://github.com/zkemail/zk-email-verify/issues). If we forget, please dm us a reminder!

We want to say thanks to these amazing contributors!!

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
For each pull request that successfully merges and addresses an [open issue](https://github.com/zkemail/zk-email-verify/issues), we offer a $50 reward. Should we overlook issuing your reward, kindly send us a direct message as a reminder. To learn more about how you can contribute to this project, please consult our [Contributing Guide](Contributing.md).

<!-- ALL-CONTRIBUTORS-LIST:END -->
A heartfelt thank you to goes to all our contributors!


## Projects 🛠
Expand Down
6 changes: 3 additions & 3 deletions docs/zkEmailDocs/Installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ To get started with zk-email, install these three npm packages:
## **1. @zk-email/helpers**
This package provides utility functions for email verification and cryptographic operations.
```
npm i @zk-email/helpers
yarn add @zk-email/helpers
```

## **2. @zk-email/contracts**
This package contains Solidity contracts for email verification.
```
npm i @zk-email/contracts
yarn add @zk-email/contracts
```
## **3. @zk-email/circuits**
This package provides circuits for generating proofs and verifying DKIM signatures in emails.
```
npm i @zk-email/circuits
yarn add @zk-email/circuits
```

[Package Overviews >](/docs/zkEmailDocs/Package%20Overviews/README.md)
2 changes: 1 addition & 1 deletion docs/zkEmailDocs/UsageGuide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This guide provides a step-by-step walkthrough on how to use the ZK Email Verifier. It covers the process from converting your email to regex to creating your zero-knowledge proof for email verification. The guide assumes you have already installed the necessary packages as outlined in the [Installation Guide](../Installation/README.md). If you haven't done so, please refer to the Installation Guide first.


For an easy setup, we suggest utilizing [Zkrepl](https://github.com/zkemail/zk-regex), a playground for compiling and testing your circuits in the early stages of development.
For an easy setup, we suggest utilizing [Zkrepl](https://github.com/zkemail/zk-regex), a playground for compiling and testing your circuits in the early stages of development. Additionally, explore our [Proof of Twitter guide](https://prove.email/blog/twitter) for a practical demonstration on how to leverage our SDKs to construct your own circuits.

## Step 1: Create the Regex File
Transform your target email string into a regex format and compile it into a regex.circom file. For guidance, visit our [zk-regex repository](https://github.com/zkemail/zk-regex).
Expand Down

0 comments on commit 622cbf1

Please sign in to comment.