How to Write a Great Readme

At Appsmith, we understand the importance of having an effective README file for your project. It serves as the front page, making a strong first impression on users and potential contributors. Our key principles for a great README include starting with the most useful information and gradually working down to technical details, avoiding walls of text by linking to additional resources, and using visuals to engage readers. These principles are reflected in our own README, which showcases our logo, provides a concise overview of Appsmith, includes automated stats and links to other resources, and highlights the value of our project. We also discuss the importance of a Code of Conduct, contribution guides, and showcasing top contributors. A well-crafted README can make a significant impact on the success and adoption of your project.

https://www.appsmith.com/blog/write-a-great-readme

To top