Skip to content

Commit

Permalink
working on the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
georgegoldman committed Nov 2, 2024
1 parent 734ae45 commit fe2615b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The **MetaMuse** is a decentralized application that allows artists to collabora
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Getting Started](#getting-started)
- [Setup and Installation](#setup-and-installation)
- [Smart Contract Development](#smart-contract-development)
- [Project Structure](#project-structure)
- [License](#license)
Expand All @@ -33,6 +34,31 @@ Make sure you have the following installed:
- [IPFS CLI](https://docs.ipfs.io/install/)
- [Foundry & Forge](https://book.getfoundry.sh/)


### Key Features

- **Contributor Shares Assignment**: The owner can assign shares to multiple contributors.
- **NFT Purchase**: The contract allows anyone to buy the NFT by paying to the contract.
- **Automatic Payment Distribution**: Upon purchase, the payment is distributed to all contributors based on their shares.
- **Events**: Emits events for tracking NFT purchases and payments made to contributors.

### Events

- `NFTPurchased(address indexed buyer, uint256 totalPaid, uint256 tokenId)`: Emitted when an NFT is purchased.
- `SharesAssigned(address indexed contributor, uint256 shares)`: Emitted when shares are assigned to a contributor.
- `PaymentDistributed(address indexed contributor, uint256 amount)`: Emitted when payments are distributed to contributors.

### Functions

- `assignShares(address[] memory _contributors, uint256[] memory _shares)`: Allows the owner to assign shares to contributors.
- `buyNFT(uint256 tokenId)`: Allows users to buy the NFT and triggers payment distribution to contributors.

## Setup and Installation
**Clone the Repository**:
```bash
git clone git@github.com:georgegoldman/metamuse.git
cd metamuse

### Installation
1. Clone the repository:
```
Expand Down

0 comments on commit fe2615b

Please sign in to comment.