Skip to content

Fix/readme typo #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AdekunleBamz wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix/readme typo #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83d24a3
docs: add CI badge and improve gitignore
BamzzStudio Jan 11, 2026
cab7c3c
docs: fix typo in README (recommneded -> recommended)
Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,6 @@ Thumbs.db

# Generated docs
docs/gen
test/docs/gen
test/docs/gen
# IDE
.vscode/
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

# Flywheel Protocol

![CI](https://github.com/AdekunleBamz/flywheel/actions/workflows/foundry-ci.yml/badge.svg)

TLDR:

- A modular, permissionless protocol for transparent attribution and ERC20 reward distribution
Expand Down Expand Up @@ -561,7 +563,7 @@ bytes memory hookData = abi.encode(

## Core Payout Operations

**Note that fee-on-transfer tokens and rebasing tokens may lead to unexpected behavior and are not recommneded for use in Flywheel.**
**Note that fee-on-transfer tokens and rebasing tokens may lead to unexpected behavior and are not recommended for use in Flywheel.**

Flywheel provides four fundamental payout operations that hooks can implement based on their requirements:

Expand Down