Skip to content

Commit

Permalink
Merge pull request #241 from zkemail/update-readme
Browse files Browse the repository at this point in the history
chore: Update new logo and links
  • Loading branch information
Bisht13 authored Dec 12, 2024
2 parents d0e6f7f + be029a2 commit ab7ddbb
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Welcome to ZK-Email
# Welcome to ZK Email

<p align="center">
<img src="docs/logo.jpg" width="300">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/logo-light.svg">
<source media="(prefers-color-scheme: light)" srcset="docs/logo-dark.svg">
<img alt="zkemail." src="docs/logo-light.svg">
</picture>
</p>

ZK Email is an application that allows for anonymous verification of email signatures while masking specific data. It enables verification of emails to/from specific domains or subsets of domains, as well as verification based on specific text in the email body. Our core SDK comes with libraries to assist with circuit generation as well as utility templates for general zk applications.
Expand All @@ -28,7 +32,7 @@ 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.

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

## Audits

Expand Down
4 changes: 4 additions & 0 deletions docs/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ab7ddbb

Please sign in to comment.