Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
morrigan committed May 26, 2024
1 parent 5fa379c commit c95729d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
# zu-git-proofs

Zu-Pass-Proofs project enables anonymous feedback in forums by assigning credibility badges based on GitHub contributions (e.g., Core Ethereum Contributor). Zu-Pass-Proofs ensures that participants can stay anon while being recognized and trusted with proven expertise. This approach fosters high-quality and reliable community discussions and governance while first maintaining user privacy, using [Zupass](https://zupass.org/).

## Development Prerequisites

- :gear: [NodeJS](https://nodejs.org/) (LTS)
- :toolbox: [Yarn](https://yarnpkg.com)
- :scroll: [Discourse](https://github.com/discourse/discourse)

## Packages Overview

Package | Description |
| ---------------- |--------------------------------------------------------------------|
| discourse-plugin | Plugin for Discourse (Ruby, Ember.js) |
| git-contributions-script | Indexing Git protocol scripts in TypeScript |
| zu-git-pass-client | Frontend app for auth between Discourse <> Github and Zupass (React) |
| zu-git-proofs-server | Backend app serving as Github oauth login and Zupass feed server (Fastify) |

0 comments on commit c95729d

Please sign in to comment.