search

mouseless-eth / rusty-sando

Implementation of a competitive v2/v3 multi-meat MEV sandwich bot written using Rust and Huff.
MIT License
767 stars 256 forks source link

(docs) create a FAQ section in the README for the Bot #43

Closed imcodingideas closed 1 year ago

imcodingideas commented 1 year ago

This pull request addresses the need for more explicit instructions and explanations within the README document. It is evident that new users or contributors might have questions regarding specific key terms and variables, such as FLASHBOTS_AUTH_KEY and SEARCHER_PRIVATE_KEY.

The proposed changes introduce sections in the README file that provide a detailed explanation for these terms. The aim is to help users understand their significance, usage, and how to properly set them up. Additionally, the PR emphasizes the importance of the Erigon archive node being fully synced before proceeding, as this has been a recurring question.

Improving our documentation with clear instructions is crucial in making the project more approachable to newcomers and ensures the smooth set-up of the application. This PR serves to enhance the user's experience and ease their onboarding process.

I believe these updates to the README will provide significant value to our community and contribute to the better understanding of the project.

Please review and provide any feedback or suggestions for improvement.

mouseless-eth commented 1 year ago

Thank u for the PR, but this is pretty common knowledge/one google search away...

The README will be very crowded if all minor details, such as these were mapped out. I rather the README be short and simple.