Skip to content

Commit

Permalink
improve root readme
Browse files Browse the repository at this point in the history
  • Loading branch information
teddyjfpender committed Aug 13, 2023
1 parent 20f988c commit 5723894
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- markdownlint-disable -->
<div align="center">
<img src="apps/docs/static/img/herald.png" height="128">
<img src="apps/docs/static/img/herald.png" height="256">
</div>
<div align="center">
<img src="apps/docs/static/img/Herald-name.png" height="128">
Expand All @@ -23,7 +23,7 @@
</a>

<a href="https://www.npmjs.com/package/herald-sdk">
<img src="https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white"/>
<img src="https://img.shields.io/badge/NPM-Herald%20SDK-CB3837?style=for-the-badge&logo=npm&logoColor=white"/>
</a>

<a href="https://https://palladians.github.io/herald/benchmarks">
Expand All @@ -48,6 +48,12 @@ Mina ecosystem, but throughout Web3.
fortress around digital identity. Embrace the power of SnarkyJS and witness the metamorphosis of the
credential ecosystem. Let Herald be the wizard's hat to your magical adventure.

Herald seeks to be compatible with the data model outlined by W3C's [**Verifiable Credential Data Model**](https://www.w3.org/TR/vc-data-model/).
It does so by mapping JSON credential objects to SnarkyJS MerkleMaps. The issuer signs the MerkleMap's root,
with that signature a subject can prove arbitrary properties of their credentials privately using ZkPrograms.
The resulting proof can then be used for many things, including in smart contracts and other SnarkyJS recursive
programs! The possible use-cases are not limited ⚡

## 🌌 Features
- Craft, Issue, and Prove Credentials 🎓
- Built upon the power of SnarkyJS 🧙‍♂️
Expand Down Expand Up @@ -94,6 +100,13 @@ Proof size is a critical factor, especially considering storage and transmission

To stay updated with Herald's benchmarking progress and insights, visit our [**Benchmark Page**](https://palladians.github.io/herald/benchmarks).

### Run Benchmarks Yourself 🚀

To run the benchmarks yourself, from the root:
```bash
pnpm i && pnpm build && pnpm run benchmark
```

## 🤝 Contribute
Herald thrives with the combined magic of our community wizards. We welcome contributors with open arms. For more details, check out our contributing guide.

Expand Down

0 comments on commit 5723894

Please sign in to comment.