Skip to content

Commit

Permalink
add demo thumbnail and some spacing to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Spencer-Sch committed Jan 9, 2024
1 parent 4f9901e commit d75e0e3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
<a hrel="https://www.youtube.com/watch?v=BrkgqdQXIII" align="center" target="_blank">
<img src="hbhr-demo-thumbnail.png" alt="Honey Badger Demo Thumbnail" />
</a>
<br>

# HoneyBadgerHR & MVMT Payroll

HoneyBadgerHR introduces the MVMT Payroll system, a Web3 solution that modernizes payroll processes using blockchain technology. This system empowers employers with flexible payroll management and incentivizes employees through an innovative KPI Raffle System.

# MVMT Payroll Smart Contract

The MVMT Payroll Smart Contract is designed to allow employers to execute payroll on multiple chains, providing employees the freedom to receive their earnings on any supported blockchain. This flexibility ensures that payroll can adapt to the diverse preferences of a global workforce.

# Raffle Smart Contract

The Raffle Smart Contract is developed as a tool for employee engagement, allowing companies to hold raffles and reward employees. This feature aims to boost morale and encourage productivity by offering incentives in the form of digital assets.

# Technologies Used
* Scaffold-ETH-3: Our project is built on top of Scaffold-ETH-3, which provided us with a robust development framework to create Ethereum-based applications efficiently.
* Dashboard Template (https://github.com/srobbin01/daisyui-admin-dashboard-template): The user interface leverages the daisyUI admin dashboard template, which offers a clean and modern UI for our front-end.
* Chainlink CCIP: Payroll.sol & TonkenTransferor.sol use CCIP to send tokens across chains
* Chainlink VRF & Automation: Raffle.sol pulls a random number from VRF to pick a winner of the raffle and is set up with Automation to pull the random number automatically once a raffle has ended.

- Scaffold-ETH-3: Our project is built on top of Scaffold-ETH-3, which provided us with a robust development framework to create Ethereum-based applications efficiently.
- Dashboard Template (https://github.com/srobbin01/daisyui-admin-dashboard-template): The user interface leverages the daisyUI admin dashboard template, which offers a clean and modern UI for our front-end.
- Chainlink CCIP: Payroll.sol & TonkenTransferor.sol use CCIP to send tokens across chains
- Chainlink VRF & Automation: Raffle.sol pulls a random number from VRF to pick a winner of the raffle and is set up with Automation to pull the random number automatically once a raffle has ended.

## Quick Start

To get started with HoneyBadgerHR:

```
Expand Down
Binary file added hbhr-demo-thumbnail.png
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 d75e0e3

Please sign in to comment.