Add badges, contributing, etc to packages

remarkjs · Jun 20, 2019 · d7750be · d7750be
1 parent 2e2105f
commit d7750be
Show file tree

Hide file tree

Showing 70 changed files with 4,545 additions and 170 deletions.
diff --git a/packages/remark-lint-blockquote-indentation/readme.md b/packages/remark-lint-blockquote-indentation/readme.md
@@ -2,6 +2,14 @@
 
 # remark-lint-blockquote-indentation
 
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Sponsors][sponsors-badge]][collective]
+[![Backers][backers-badge]][collective]
+[![Chat][chat-badge]][chat]
+
 Warn when blockquotes are indented too much or too little.
 
 Options: `number` or `'consistent'`, default: `'consistent'`.
@@ -81,11 +89,13 @@ Paragraph.
 
 ## Install
 
+[npm][]:
+
 ```sh
 npm install remark-lint-blockquote-indentation
 ```
 
-## Usage
+## Use
 
 You probably want to use it on the CLI through a config file:
 
@@ -122,6 +132,56 @@ Or use this on the API:
    });
 ```
 
+## Contribute
+
+See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
+to get started.
+See [`support.md`][support] for ways to get help.
+
+This project has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
+
 ## License
 
-[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com)
+[MIT][license] © [Titus Wormer][author]
+
+[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg
+
+[build]: https://travis-ci.org/remarkjs/remark-lint
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
+
+[coverage]: https://codecov.io/github/remarkjs/remark-lint
+
+[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-blockquote-indentation.svg
+
+[downloads]: https://www.npmjs.com/package/remark-lint-blockquote-indentation
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-blockquote-indentation.svg
+
+[size]: https://bundlephobia.com/result?p=remark-lint-blockquote-indentation
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[collective]: https://opencollective.com/unified
+
+[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
+
+[chat]: https://spectrum.chat/unified/remark
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[health]: https://github.com/remarkjs/.github
+
+[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md
+
+[support]: https://github.com/remarkjs/.github/blob/master/support.md
+
+[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md
+
+[license]: https://github.com/remarkjs/remark-lint/blob/master/license
+
+[author]: https://wooorm.com
diff --git a/packages/remark-lint-checkbox-character-style/readme.md b/packages/remark-lint-checkbox-character-style/readme.md
@@ -2,6 +2,14 @@
 
 # remark-lint-checkbox-character-style
 
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Sponsors][sponsors-badge]][collective]
+[![Backers][backers-badge]][collective]
+[![Chat][chat-badge]][chat]
+
 Warn when list item checkboxes violate a given style.
 
 Options: `Object` or `'consistent'`, default: `'consistent'`.
@@ -142,11 +150,13 @@ When configured with `{ checked: '!' }`.
 
 ## Install
 
+[npm][]:
+
 ```sh
 npm install remark-lint-checkbox-character-style
 ```
 
-## Usage
+## Use
 
 You probably want to use it on the CLI through a config file:
 
@@ -183,6 +193,56 @@ Or use this on the API:
    });
 ```
 
+## Contribute
+
+See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
+to get started.
+See [`support.md`][support] for ways to get help.
+
+This project has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
+
 ## License
 
-[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com)
+[MIT][license] © [Titus Wormer][author]
+
+[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg
+
+[build]: https://travis-ci.org/remarkjs/remark-lint
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
+
+[coverage]: https://codecov.io/github/remarkjs/remark-lint
+
+[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-checkbox-character-style.svg
+
+[downloads]: https://www.npmjs.com/package/remark-lint-checkbox-character-style
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-checkbox-character-style.svg
+
+[size]: https://bundlephobia.com/result?p=remark-lint-checkbox-character-style
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[collective]: https://opencollective.com/unified
+
+[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
+
+[chat]: https://spectrum.chat/unified/remark
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[health]: https://github.com/remarkjs/.github
+
+[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md
+
+[support]: https://github.com/remarkjs/.github/blob/master/support.md
+
+[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md
+
+[license]: https://github.com/remarkjs/remark-lint/blob/master/license
+
+[author]: https://wooorm.com
diff --git a/packages/remark-lint-checkbox-content-indent/readme.md b/packages/remark-lint-checkbox-content-indent/readme.md
@@ -2,6 +2,14 @@
 
 # remark-lint-checkbox-content-indent
 
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Sponsors][sponsors-badge]][collective]
+[![Backers][backers-badge]][collective]
+[![Chat][chat-badge]][chat]
+
 Warn when list item checkboxes are followed by too much whitespace.
 
 ## Presets
@@ -46,11 +54,13 @@ No messages.
 
 ## Install
 
+[npm][]:
+
 ```sh
 npm install remark-lint-checkbox-content-indent
 ```
 
-## Usage
+## Use
 
 You probably want to use it on the CLI through a config file:
 
@@ -87,6 +97,56 @@ Or use this on the API:
    });
 ```
 
+## Contribute
+
+See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
+to get started.
+See [`support.md`][support] for ways to get help.
+
+This project has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
+
 ## License
 
-[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com)
+[MIT][license] © [Titus Wormer][author]
+
+[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg
+
+[build]: https://travis-ci.org/remarkjs/remark-lint
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
+
+[coverage]: https://codecov.io/github/remarkjs/remark-lint
+
+[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-checkbox-content-indent.svg
+
+[downloads]: https://www.npmjs.com/package/remark-lint-checkbox-content-indent
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-checkbox-content-indent.svg
+
+[size]: https://bundlephobia.com/result?p=remark-lint-checkbox-content-indent
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[collective]: https://opencollective.com/unified
+
+[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
+
+[chat]: https://spectrum.chat/unified/remark
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[health]: https://github.com/remarkjs/.github
+
+[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md
+
+[support]: https://github.com/remarkjs/.github/blob/master/support.md
+
+[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md
+
+[license]: https://github.com/remarkjs/remark-lint/blob/master/license
+
+[author]: https://wooorm.com
diff --git a/packages/remark-lint-code-block-style/readme.md b/packages/remark-lint-code-block-style/readme.md
@@ -2,6 +2,14 @@
 
 # remark-lint-code-block-style
 
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Sponsors][sponsors-badge]][collective]
+[![Backers][backers-badge]][collective]
+[![Chat][chat-badge]][chat]
+
 Warn when code blocks do not adhere to a given style.
 
 Options: `'consistent'`, `'fenced'`, or `'indented'`, default: `'consistent'`.
@@ -150,11 +158,13 @@ When configured with `'invalid'`.
 
 ## Install
 
+[npm][]:
+
 ```sh
 npm install remark-lint-code-block-style
 ```
 
-## Usage
+## Use
 
 You probably want to use it on the CLI through a config file:
 
@@ -191,6 +201,56 @@ Or use this on the API:
    });
 ```
 
+## Contribute
+
+See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
+to get started.
+See [`support.md`][support] for ways to get help.
+
+This project has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
+
 ## License
 
-[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com)
+[MIT][license] © [Titus Wormer][author]
+
+[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg
+
+[build]: https://travis-ci.org/remarkjs/remark-lint
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
+
+[coverage]: https://codecov.io/github/remarkjs/remark-lint
+
+[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-code-block-style.svg
+
+[downloads]: https://www.npmjs.com/package/remark-lint-code-block-style
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-code-block-style.svg
+
+[size]: https://bundlephobia.com/result?p=remark-lint-code-block-style
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[collective]: https://opencollective.com/unified
+
+[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
+
+[chat]: https://spectrum.chat/unified/remark
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[health]: https://github.com/remarkjs/.github
+
+[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md
+
+[support]: https://github.com/remarkjs/.github/blob/master/support.md
+
+[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md
+
+[license]: https://github.com/remarkjs/remark-lint/blob/master/license
+
+[author]: https://wooorm.com