Skip to content

Commit

Permalink
Offer the option to use flat badges (sindresorhus#1268)
Browse files Browse the repository at this point in the history
  • Loading branch information
bokub authored and sindresorhus committed Apr 16, 2018
1 parent 38fe469 commit 8d97c26
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
12 changes: 8 additions & 4 deletions awesome.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,29 @@ Research if the stuff you're including is actually awesome. Only put stuff on th
This badge is for Awesome lists.

[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
[![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re)

Add an awesome badge to the top of your list, right next to the title. [Example](https://github.com/sindresorhus/awesome-nodejs).
Add an awesome badge to the top of your list, right next to the title. [Example](https://github.com/sindresorhus/awesome-nodejs). You can choose either the regular badge or the flat one.

```md
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
[![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re)
```

*The badge should not be modified in any way.*
*The badges should not be modified in any way.*

## Awesome mentioned badge

This badge is for projects being mentioned in an Awesome list (**NOT for use in Awesome lists**). For example, the [Chalk](https://github.com/chalk/chalk) project could feature this badge because it's listed in [Awesome Node.js](https://github.com/sindresorhus/awesome-nodejs). It's totally optional for projects, but it's a nice way to show they've been featured in an Awesome list.
This badge is for projects being mentioned in an Awesome list (**NOT for use in Awesome lists**). For example, the [Chalk](https://github.com/chalk/chalk) project could feature this badge because it's listed in [Awesome Node.js](https://github.com/sindresorhus/awesome-nodejs). It's totally optional for projects, but it's a nice way to show they've been featured in an Awesome list. You can choose either the regular badge or the flat one.

[![Mentioned in Awesome](https://awesome.re/mentioned-badge.svg)](https://awesome.re)
[![Mentioned in Awesome](https://awesome.re/mentioned-badge-flat.svg)](https://awesome.re)

**Fill in the placeholders (Name and URL):**

```md
[![Mentioned in Awesome <INSERT LIST NAME>](https://awesome.re/mentioned-badge.svg)](https://github.com/<INSERT LIST URL>)
[![Mentioned in Awesome <INSERT LIST NAME>](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/<INSERT LIST URL>)
```

Example:
Expand All @@ -42,7 +46,7 @@ Example:

If you're an Awesome list maintainer, you could encourage projects in your list to add the badge.

*The badge should not be modified in any way.*
*The badges should not be modified in any way.*

## Comment on why something is awesome

Expand Down
1 change: 1 addition & 0 deletions media/badge-flat.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions media/mentioned-badge-flat.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8d97c26

Please sign in to comment.