Skip to content

Consider adding license badge from shields.io #525

Closed
@ssokolow

Description

@ssokolow

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:

  1. 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.)
  2. Depending on the user, it may be significantly more eye-catching than plain text.
  3. Having a section (License) with just one word in it (MIT) looks unpolished.

Here's the badge and the markdown involved:

MIT licensed

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](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

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions