From d013ba37af5dd24e171ba0bbd9a0f153229ee49c Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Thu, 13 Jun 2019 13:42:39 +0200 Subject: [PATCH] Refactor prose --- readme.md | 36 +++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/readme.md b/readme.md index 01650ec..c8473ff 100644 --- a/readme.md +++ b/readme.md @@ -3,21 +3,23 @@ [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] [![Chat][chat-badge]][chat] Streaming interface to [unified][] processors. Note that the interface is streaming, but the code buffers. -## Installation +## Install [npm][]: -```bash +```sh npm install unified-stream ``` -## Usage +## Use The below example pipes stdin, into an HTML formatter, to stdout. @@ -37,11 +39,13 @@ Create a readable/writable stream that transforms with `processor`. ## Contribute -See [`contributing.md` in `unifiedjs/unified`][contributing] for ways to get -started. +See [`contributing.md`][contributing] in [`unifiedjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. -This organisation has a [Code of Conduct][coc]. By interacting with this -repository, organisation, or community you agree to abide by its terms. +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. ## License @@ -61,18 +65,28 @@ repository, organisation, or community you agree to abide by its terms. [downloads]: https://www.npmjs.com/package/unified-stream +[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 [npm]: https://docs.npmjs.com/cli/install +[health]: https://github.com/unifiedjs/.github + +[contributing]: https://github.com/unifiedjs/.github/blob/master/contributing.md + +[support]: https://github.com/unifiedjs/.github/blob/master/support.md + +[coc]: https://github.com/unifiedjs/.github/blob/master/code-of-conduct.md + [license]: license [author]: https://wooorm.com [unified]: https://github.com/unifiedjs/unified - -[contributing]: https://github.com/unifiedjs/unified/blob/master/contributing.md - -[coc]: https://github.com/unifiedjs/unified/blob/master/code-of-conduct.md