Skip to content

Commit 15b0d18

Browse files
committed
Improve readme
1 parent 9e0fd81 commit 15b0d18

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
1-
# 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)
1+
# 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)
22

3-
## What is Council?
43

5-
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).
4+
## What is CouncilHaus?
5+
6+
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.
7+
8+
![](https://ipfs.blossom.software/ipfs/QmS39MkssLK2Tvv63NK7aYVmyDsDGJCJ2LEtBSr1saisK4)
69

710
## Key Features
811

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

1518
## How It Works
1619

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

22-
## Why Use Council?
25+
## Why Use CouncilHaus?
2326

24-
Council brings several benefits to organizations looking to manage grant or fund allocation:
27+
CouncilHaus brings several benefits to organizations looking to manage grant or fund allocation:
2528

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

31-
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.
34+
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.
3235

3336
## How to run
3437

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

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

@@ -41,4 +44,6 @@ bun install
4144
bun run dev
4245
```
4346

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

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
"devDependencies": {
1717
"@biomejs/biome": "1.8.3",
1818
"husky": "^9.1.5",
19-
"prettier": "^3.2.5",
2019
"turbo": "^2.1.1",
2120
"typescript": "^5.4.5"
2221
},

0 commit comments

Comments
 (0)