search

nestorsalceda / mamba

The definitive testing tool for Python. Born under the banner of Behavior Driven Development (BDD).
http://nestorsalceda.github.io/mamba
MIT License
518 stars 65 forks source link

Improve the README.md #94

Closed andrewminer closed 6 years ago

andrewminer commented 6 years ago

When evaluating potential packages to use, I generally will only scan through the README.md file for the GitHub repository. Sometimes, if the page is very empty and clearly refers to documentation living elsewhere, I'll follow it. With this repo, even being highly motivated to find the documentation, I couldn't find it. It was only by seeing the old README on the Pip page, and then digging around in the commit history to the README.md was I able to figure out that one of the badges was actually clickable and would lead me to the docs.

Please, PLEASE, PLEASE update the read me to have at least a clear explanation of the package along with an example or two. If you'd like to keep more extensive docs elsewhere, please, PLEASE, PLEASE include an unambiguous link within the body of the text!

nestorsalceda commented 6 years ago

@andrewminer what do you think about the new README?

Do you miss something??

Thanks!

andrewminer commented 6 years ago

That looks great! Thanks, @nestorsalceda!