Closed
Description
There are three reasons why I think you should at least consider using a badge from shields.io to indicate the license in README.md:
- It allows you to comfortably put the license at the top of the file so people dropping in don't have to scroll down past the examples. (I don't know about you but I always check a library's license before I consider the merits of its API.)
- Depending on the user, it may be significantly more eye-catching than plain text.
- Having a section (License) with just one word in it (MIT) looks unpolished.
Here's the badge and the markdown involved:
[](https://raw.githubusercontent.com/hyperium/hyper/master/LICENSE)
...or you could pull it dynamically from the GitHub or crates.io metadata APIs by using one of these image URLs:
https://img.shields.io/github/license/hyperium/hyper.svg
https://img.shields.io/crates/l/hyper.svg
Metadata
Metadata
Assignees
Labels
No labels