-
Notifications
You must be signed in to change notification settings - Fork 55
docs: improve README clarity, structure, and integrator guidance #475
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.
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
base: master
Are you sure you want to change the base?
Conversation
🛡️ Immunefi PR ReviewsWe noticed that your project isn't set up for automatic code reviews. If you'd like this PR reviewed by the Immunefi team, you can request it manually using the link below: Once submitted, we'll take care of assigning a reviewer and follow up here. |
SummaryThis PR improves documentation by fixing typos in the README and expanding internal comments to clarify intent. Changes
|
|
Hi @dekz, the PR is ready for review! Changes include:
Let me know if you'd like any changes! |
Description
This PR improves the repository documentation to provide a clearer entry point for integrators and developers. It restructures the README.md to explain the core concepts of 0x Settler upfront, without changing any existing technical details or addresses.
Changes
Motivation
To make the 0x Settler protocol more accessible to new integrators by providing better context and high-level explanations before diving into technical specifics.