Permalink
Browse files

Add guide for mentioned badge

  • Loading branch information...
sindresorhus committed Oct 22, 2017
1 parent a90737e commit 797812a80964486b5633361766b528b1359e516b
Showing with 28 additions and 2 deletions.
  1. +28 −2 awesome.md
View
@@ -10,14 +10,40 @@ Research if the stuff you're including is actually awesome. Only put stuff on th
## Awesome badge
[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
This badge is for Awesome lists.
[![Awesome](https://awesome.re/badge.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).
```md
[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
```
*The badge 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.
[![Mentioned in Awesome](https://awesome.re/mentioned-badge.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>)
```
Example:
```md
[![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge.svg)](https://github.com/sindresorhus/awesome-nodejs)
```
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.*
## Comment on why something is awesome
Apart from suggesting a particular item on your list, you should also inform your readers *why* it's on the list and how they will benefit from it.

0 comments on commit 797812a

Please sign in to comment.