Skip to content

docs: rewrite README for the current USDC bounty workflow#44

Open
notjamyfriench wants to merge 2 commits into
andr-drgm:mainfrom
notjamyfriench:docs/issue-40-readme-refresh
Open

docs: rewrite README for the current USDC bounty workflow#44
notjamyfriench wants to merge 2 commits into
andr-drgm:mainfrom
notjamyfriench:docs/issue-40-readme-refresh

Conversation

@notjamyfriench
Copy link
Copy Markdown

Summary

This updates the README to match the current product behavior and bounty flow.

What changed

  • Reframed project as a GitHub issue bounty marketplace paid in USDC
  • Added maintainer + solver lifecycle and claim steps
  • Documented webhook setup required for automated status transitions
  • Added API endpoint overview for bounties/github/user routes
  • Added accurate local setup and environment variable section
  • Removed outdated NFT/SOL positioning and corrupted text artifacts

Closes #40

@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 24, 2026

@lounesmechouek is attempting to deploy a commit to the Andrei's projects Team on Vercel.

A member of the Team first needs to authorize it.

@notjamyfriench notjamyfriench mentioned this pull request Feb 24, 2026
@notjamyfriench notjamyfriench force-pushed the docs/issue-40-readme-refresh branch from 345f1fc to a61c359 Compare February 24, 2026 00:20
@notjamyfriench
Copy link
Copy Markdown
Author

@andr-drgm quick follow-up: this README rewrite is aligned with the current codebase and payout flow (USDC bounty lifecycle, webhook setup, API routes, env setup). If you want, I can adapt wording to your preferred tone in a fast patch.

@notjamyfriench
Copy link
Copy Markdown
Author

Quick update: I pushed a focused README improvement commit that adds an explicit issue #40 acceptance checklist for faster review mapping. Commit: 9550ca2 on this PR branch. If you want, I can also split the checklist into a dedicated section near Contributing for even faster scanability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enchance README

1 participant