Skip to content

docs: add badges and dev quickstart #19

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 1 commit into
base: main
Choose a base branch
from
Open

docs: add badges and dev quickstart #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Builder Codes

An ERC-721 NFT contract that enables builders to register unique codes (e.g., `"myapp"`) with an associated payout addresses for revenue attribution and distribution. Implements the [ERC-8021](https://eip.tools/eip/8021) `ICodesRegistry` interface.
[![CI](https://github.com/AdekunleBamz/builder-codes/actions/workflows/test.yml/badge.svg)](https://github.com/AdekunleBamz/builder-codes/actions/workflows/test.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE.md)

An ERC-721 NFT contract that enables builders to register unique codes (e.g., `"myapp"`) with an associated payout address for revenue attribution and distribution.

## Features

Expand Down Expand Up @@ -117,3 +120,11 @@ BuilderCodes implements a permission-gated transfer system to control how codes

This design enables intentional rollout of specific transfer patterns, such as controlled marketplaces or recovery mechanisms.

## Development

```bash
forge install
forge fmt
forge test -vvv
```