A http://README.md is my favorite form of documentation
A http://README.md is my favorite form of documentation.
✅ No navigation overhead
✅ Easy to search via find
✅ Easy to download for offline access
✅ Co-located with code = convenient
✅ Lightweight markdown
✅ Syntax highlighting
✅ Submit a PR for improvements
Sure, some separate doc sites get all this right. But surprisingly, it takes a lot of work just to match the usability of a good ‘ol README.