Skip to content
This repository was archived by the owner on Aug 19, 2026. It is now read-only.

Commit d1f0aa7

Browse files
authored
Merge pull request #1741 from privacy-scaling-explorations/docs/readme
docs(readme): update readme
2 parents 61fc2f3 + 3114fe2 commit d1f0aa7

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ To contribute to MACI, create feature/fix branches, then open PRs into `dev`. [L
4040

4141
For installation and local development instructions, please see our [installation docs](https://maci.pse.dev/docs/quick-start/installation/).
4242

43-
This repository is organized as Lerna submodules. Each submodule contains its
43+
This repository is organized as pnpm workspace. Each package contains its
4444
own unit tests.
4545

4646
- `crypto`: low-level cryptographic operations.
@@ -55,6 +55,8 @@ own unit tests.
5555
an instance of MACI.
5656
- `integrationTests`: Integration tests which use the command-line interface
5757
to perform end-to-end tests.
58+
- `subgraph`: The subgraph for the MACI contracts.
59+
- `website`: The documentation website.
5860

5961
### Testing
6062

@@ -66,38 +68,43 @@ CI pipeline ensures that we have automated tests that constantly validate. For m
6668

6769
[telegram-badge]: https://badges.aleen42.com/src/telegram.svg
6870
[telegram-link]: https://t.me/joinchat/LUgOpE7J2gstRcZqdERyvw
69-
[circuits-package]: ./circuits
71+
[circuits-package]: ./packages/circuits
7072
[circuits-npm-badge]: https://img.shields.io/npm/v/maci-circuits.svg
7173
[circuits-npm-link]: https://www.npmjs.com/package/maci-circuits
7274
[circuits-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/circuit-build.yml/badge.svg
7375
[circuits-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3ACircuit
74-
[cli-package]: ./cli
76+
[cli-package]: ./packages/cli
7577
[cli-npm-badge]: https://img.shields.io/npm/v/maci-cli.svg
7678
[cli-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/e2e.yml/badge.svg
7779
[cli-npm-link]: https://www.npmjs.com/package/maci-cli
7880
[cli-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3ACI
79-
[contracts-package]: ./contracts
81+
[contracts-package]: ./packages/contracts
8082
[contracts-npm-badge]: https://img.shields.io/npm/v/maci-contracts.svg
8183
[contracts-npm-link]: https://www.npmjs.com/package/maci-contracts
8284
[contracts-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/contracts-build.yml/badge.svg
8385
[contracts-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Acontracts
84-
[core-package]: ./core
86+
[core-package]: ./packages/core
8587
[core-npm-badge]: https://img.shields.io/npm/v/maci-core.svg
8688
[core-npm-link]: https://www.npmjs.com/package/maci-core
8789
[core-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/core-build.yml/badge.svg
8890
[core-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Acore
89-
[crypto-package]: ./crypto
91+
[crypto-package]: ./packages/crypto
9092
[crypto-npm-badge]: https://img.shields.io/npm/v/maci-crypto.svg
9193
[crypto-npm-link]: https://www.npmjs.com/package/maci-crypto
9294
[crypto-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/crypto-build.yml/badge.svg
9395
[crypto-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Acrypto
94-
[domainobjs-package]: ./domainobjs
96+
[domainobjs-package]: ./packages/domainobjs
9597
[domainobjs-npm-badge]: https://img.shields.io/npm/v/maci-domainobjs.svg
9698
[domainobjs-npm-link]: https://www.npmjs.com/package/maci-domainobjs
9799
[domainobjs-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/domainobjs-build.yml/badge.svg
98100
[domainobjs-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Adomainobjs
99-
[integrationTests-package]: ./integrationTests
101+
[integrationTests-package]: ./packages/integrationTests
100102
[integrationTests-npm-badge]: https://img.shields.io/npm/v/maci-integrationtests.svg
101103
[integrationTests-npm-link]: https://www.npmjs.com/package/maci-integrationtests
102104
[integrationTests-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/e2e.yml/badge.svg
103105
[integrationTests-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3ACI
106+
[subgraph-package]: ./apps/subgraph
107+
[subgraph-npm-badge]: https://img.shields.io/npm/v/maci-subgraph.svg
108+
[subgraph-npm-link]: https://www.npmjs.com/package/maci-subgraph
109+
[subgraph-actions-badge]: https://github.com/privacy-scaling-explorations/maci/actions/workflows/subgraph-build.yml/badge.svg
110+
[subgraph-actions-link]: https://github.com/privacy-scaling-explorations/maci/actions?query=workflow%3Asubgraph

0 commit comments

Comments
 (0)