Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
carlbarrdahl committed Jan 24, 2025
1 parent 9befb18 commit a9e4838
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ Allo Kit gets you up and running building Allocation Strategies in no time!

https://github.com/allocapital/allo-kit

## Features

- Register Project
- Browse Projects
- Directly Allocate tokens to Projects (currently configured to ERC20Mock)
- Quadratic Funding
- Fund Matching Pool to SimpleGrants strategy contract
- Client-side calculation of quadratic based on Allocations to Projects
- Distribute Matching Pool to Projects based on quadratic shares
- Indexer
- Project registration and approval events
- Token transfers to and from addresses via Allocate
- Token amounts also in USD amount at time of transfer

## Getting Started

### Update .env variables
Expand All @@ -23,6 +37,12 @@ PINATA_JWT=
PINATA_GATEWAY_URL=
```

Update the Alchemy key. This is needed to fetch the token price in USD.

```sh
ALCHEMY_API_KEY=
```

### Development

```sh
Expand Down

0 comments on commit a9e4838

Please sign in to comment.