Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sembrestels committed Oct 16, 2024
1 parent 9e0fd81 commit 15b0d18
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# CouncilHaus: A Decentralized Grant Allocation System [![Coverage Status](https://coveralls.io/repos/github/BlossomLabs/councilhaus/badge.svg?branch=master&dummy=unused)](https://coveralls.io/github/BlossomLabs/councilhaus?branch=master)
# CouncilHaus: A Continuous and Participatory Budget Allocation dApp [![Coverage Status](https://coveralls.io/repos/github/BlossomLabs/councilhaus/badge.svg?branch=master&dummy=unused)](https://coveralls.io/github/BlossomLabs/councilhaus?branch=master)

## What is Council?

Council is an innovative system designed to democratize and streamline the process of allocating grants or funds within an organization. It's like a digital roundtable where designated council members can collaboratively decide how to distribute resources to various projects or individuals (called grantees).
## What is CouncilHaus?

CouncilHaus enables organizations with a set budget to allocate funds continuously among grantees. Council members vote to decide how the budget is distributed dynamically, ensuring efficient use of resources, reducing administrative overhead, and allowing real-time adjustments to meet evolving needs.

![](https://ipfs.blossom.software/ipfs/QmS39MkssLK2Tvv63NK7aYVmyDsDGJCJ2LEtBSr1saisK4)

## Key Features

1. **Democratic Decision Making**: Council members are given voting power, allowing them to have a say in how funds are distributed.
1. **Participatory Decision Making**: Council members actively decide how funds are distributed, fostering a more inclusive allocation process.
2. **Flexible Allocation**: Members can allocate their voting power across multiple grantees, supporting various projects as they see fit.
3. **Transparent Process**: All allocations and decisions are recorded, ensuring a clear and auditable trail of fund distribution.
3. **Transparent Process**: All allocations and decisions are recorded, providing a clear and auditable trail of fund distribution.
4. **Managed Access**: The system includes roles for administering members and grantees, maintaining control over who can participate.
5. **Fair Distribution**: Once allocations are decided, the system automatically handles the distribution of funds to grantees.
5. **Automatic Distribution**: Once allocations are decided, the system automatically handles the distribution of funds to grantees.

## How It Works

Expand All @@ -19,20 +22,20 @@ Council is an innovative system designed to democratize and streamline the proce
3. **Budget Allocation**: Council members use their voting power to allocate funds to grantees they wish to support.
4. **Automatic Distribution**: Once allocations are set, the system takes care of distributing the funds according to the council's decisions.

## Why Use Council?
## Why Use CouncilHaus?

Council brings several benefits to organizations looking to manage grant or fund allocation:
CouncilHaus brings several benefits to organizations looking to manage grant or fund allocation:

- **Decentralized Decision Making**: It moves away from top-down fund allocation, embracing a more collaborative approach.
- **Participation**: Encourages active involvement by recognizing and rewarding contributions, creating a more engaged, motivated, and thriving community.
- **Flexibility**: Council members can easily adjust their allocations, responding to changing needs or priorities.
- **Efficiency**: The automated distribution system reduces administrative overhead.
- **Transparency**: All decisions are recorded, promoting trust and accountability.

Whether you're a non-profit organization, a research institution, or any entity that needs to manage collective fund allocation, Council provides a modern, fair, and efficient solution to empower your team and streamline your grant-giving process.
Whether you're a company, a DAO interested in funding an ecosystem of contributors, a public-goods organization, or any entity that needs to manage collective fund allocation, CouncilHaus offers a modern, flexible, and efficient solution to empower your team and streamline grant-giving. For instance, Superfluid has used CouncilHaus to reward ecosystem contributors in an ongoing hackathon, with demo days every two weeks.

## How to run

Install bun from https://bun.sh/
Install bun (a fast JavaScript runtime) from [https://bun.sh/](https://bun.sh/) or just use `npm install -g bun`.

Use `bun` to install dependencies and run the project:

Expand All @@ -41,4 +44,6 @@ bun install
bun run dev
```

The smart contracts are in the `contracts` directory, and the frontend is in the `apps` directory.
The development server will be available at http://localhost:3000/.

The smart contracts are in the `contracts` directory, and the frontend is in the `apps` directory.
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"devDependencies": {
"@biomejs/biome": "1.8.3",
"husky": "^9.1.5",
"prettier": "^3.2.5",
"turbo": "^2.1.1",
"typescript": "^5.4.5"
},
Expand Down

0 comments on commit 15b0d18

Please sign in to comment.