Skip to content

Commit 55f6037

Browse files
committed
docs: small nits on readmes
1 parent 3b19b24 commit 55f6037

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Excubiae
22

3-
Excubiae is a composable framework for building custom attribute-based access control policies on Ethereum.
3+
Excubiae is a composable framework for creating custom attribute-based access control policies on EVM-compatible networks.
44

5-
The framework provides a set of common, abstract, and flexible smart contracts to simplify the creation of reusable, attribute-based criteria. These contracts, called "gatekeepers," are solution-agnostic, enforcing checks against user-provided evidence and maintaining records of those who meet the criteria.
5+
It provides a set of abstract and flexible smart contracts, known as "gatekeepers," to streamline the definition of reusable criteria. These solution-agnostic contracts enforce checks against user-provided evidence and track those who satisfy the requirements.
66

7-
This approach enables seamless interoperability across different protocols. For instance, a single check could combine verifiable attributes from Semaphore and MACI, ensuring flexible and composable access control based on two different protocols. Indeed, for example, you can define criteria to verify token ownership or/and validate a zero-knowledge proof (ZKP). Using these criteria, you can create a policy to enforce the checks and integrate it seamlessly into your smart contract logic. A practical use case might involve requiring verification before registering a new voter for a poll (e.g., in a MACI-based voting system).
7+
This approach enables seamless interoperability across different protocols. For instance, a single check could combine verifiable attributes from Semaphore and MACI, ensuring flexible and composable access control. Indeed, for example, you can define criteria to verify token ownership and/or validate a zero-knowledge proof (ZKP). Using these criteria, you can create a policy to enforce the checks and integrate it seamlessly into your smart contract logic. A practical use case might involve requiring verification before registering a new voter for a poll (e.g., in a MACI-based voting system).
88

99
You can learn more in this [design document](https://hackmd.io/@0xjei/B1RXoTh71e).
1010

@@ -77,7 +77,7 @@ yarn compile:contracts
7777

7878
```bash
7979
yarn version:bump <package-name> <version>
80-
# e.g. yarn version:bump imt.sol 2.0.0
80+
# e.g. yarn version:bump excubiae 0.2.0
8181
```
8282

8383
This step creates a commit and a git tag.
@@ -92,7 +92,7 @@ git push origin main
9292

9393
```bash
9494
git push origin <package-name>-<version>
95-
# e.g. git push origin excubiae-v0.1.0
95+
# e.g. git push origin excubiae-v0.2.0
9696
```
9797

9898
After pushing the new git tag, a workflow will be triggered and will publish the package on [npm](https://www.npmjs.com/) and release a new version on Github with its changelogs automatically.

packages/contracts/contracts/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ yarn add @excubiae/contracts
2020

2121
## Usage
2222

23-
This package is configured to support the combination of [Hardhat](https://hardhat.org/) and [Foundry](https://book.getfoundry.sh/), see the Hardhat [documentation](https://hardhat.org/hardhat-runner/docs/advanced/hardhat-and-foundry) to learn more.
23+
This package is configured to support the combination of [Hardhat](https://hardhat.org/) and [Foundry](https://book.getfoundry.sh/), see the Hardhat's [documentation](https://hardhat.org/hardhat-runner/docs/advanced/hardhat-and-foundry) to learn more.
2424

2525
### Compile contracts
2626

0 commit comments

Comments
 (0)