docs: README + llms.txt reflect the current solution (diagrams, usage, agent contract) - #37
Merged
Merged
Conversation
README now reflects the live two-sided market: credit-balance model, fee waterfall (75/20/5), multi-chain (Base+Celo, payment-chain=earning-chain), x402 deposits via PerkOS Stack, PerkosClaimVault pull-claims, and the $PERKOS monthly usage drop. Adds three Mermaid diagrams (system architecture, the economic loop, the month-end drop sequence), agent usage (curl + plugin), an endpoint reference table, and tokenomics/claim sections. llms.txt: frame the claim as USDC earnings + a monthly $PERKOS usage drop (5% accrued -> month-end buyback -> distributed by usage); note the plugin sets payChain + emits a 402 top-up hint.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the public docs up to date with what is actually live.
README (root)
Rewritten around the current two-sided market:
PerkosClaimVaultpull-claims, the monthly $PERKOS usage drop + themonthly-drop.mjsorchestrator runbook.llms.txt (agent contract)
payChainand emits a plain-language402top-up hint.Docs-only; nothing deploys until the App is rsync’d.