Offer the option to use flat badges (#1268)

This commit is contained in:
Boris K
2018-04-16 10:41:56 +02:00
committed by Sindre Sorhus
parent 38fe469625
commit 8d97c26d1a
3 changed files with 10 additions and 4 deletions

View File

@@ -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:
@@ -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