Skip to content

Commit

Permalink
docs: add app screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
decebal committed Nov 17, 2024
1 parent 7940623 commit 2d20be2
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ Rent2Own is a decentralized platform that allows users to rent NFTs with the opt

The `RentToOwn` smart contract facilitates rental agreements for ERC721 NFTs, allowing users to eventually own the NFT by making monthly payments. Here's a breakdown of its functionalities:

![Load NFT](./assets/load-nft.jpeg)

- **Listing NFTs:** Lenders can list their NFTs by specifying the monthly payment and the total number of payments required for ownership.
- **Starting Agreements:** Borrowers initiate agreements by making the first payment, which assigns them as the borrower.
- **Making Payments:** Borrowers continue making monthly payments. Once all payments are made, ownership of the NFT is transferred to the borrower.
Expand All @@ -64,6 +66,7 @@ The `RentToOwn` smart contract facilitates rental agreements for ERC721 NFTs, al

1. **List an NFT for Rent-to-Own:**

![List NFT](./assets/lend-nft.jpeg)
- **Function:** `listNFT`
- **Parameters:**
- `_nftContract`: Address of the ERC721 contract.
Expand All @@ -79,8 +82,9 @@ The `RentToOwn` smart contract facilitates rental agreements for ERC721 NFTs, al

### For Borrowers

1. **Start an Agreement:**
![Agreements](./assets/agreements.jpeg)

1. **Start an Agreement:**
- **Function:** `startAgreement`
- **Parameters:**
- `_agreementId`: ID of the rental agreement.
Expand Down Expand Up @@ -120,8 +124,6 @@ The `RentToOwn` smart contract facilitates rental agreements for ERC721 NFTs, al
- 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet.
- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network.

![Debug Contracts tab](https://github.com/scaffold-eth/scaffold-eth-2/assets/55535804/b237af0c-5027-4849-a5c1-2e31495cccb1)

## Requirements

Before you begin, you need to install the following tools:
Expand Down
Binary file added assets/agreements.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/lend-nft.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/load-nft.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2d20be2

Please sign in to comment.