Skip to content

Add MIT LICENSE, Improve README#80

Open
phessophissy wants to merge 2 commits intobuttonwood-protocol:mainfrom
phessophissy:main
Open

Add MIT LICENSE, Improve README#80
phessophissy wants to merge 2 commits intobuttonwood-protocol:mainfrom
phessophissy:main

Conversation

@phessophissy
Copy link
Copy Markdown

Changes

  • Added MIT LICENSE file (was missing from the repository)
  • Improved README.md with:
    • Project badges (License, Solidity version, Foundry)
    • Project description explaining Consol Protocol is a decentralized mortgage lending platform
    • Features section highlighting mortgage origination, origination pools, multi-token vaults, lender queues, conversion system, order pool, and yield strategies
    • Architecture diagram showing the main contracts
    • Security section linking to the Guardian audit in audits/
    • Prerequisites section (Foundry, Node.js, pnpm)
    • Improved installation and usage instructions
    • Link to LICENSE file

Testing:

Documentation only - no code changes. Verified markdown renders correctly.

Reviewers:

@SocksNFlops

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.

1 participant