From 629ce27884b3155f3b22a5f345ad6d0af2c5786b Mon Sep 17 00:00:00 2001 From: SmartFlow Developer Date: Sat, 10 Jan 2026 22:01:27 +0100 Subject: [PATCH] docs: add badges and dev quickstart - Add CI + license badges to the README - Remove inaccurate ERC-8021/ICodesRegistry claim - Add quickstart commands for local development --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 13767fe..bf327df 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 +``` +