From 58812035c105ef60c754d5d2de8c941c235e68e7 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Tue, 31 Oct 2023 11:22:41 +0200 Subject: [PATCH] chore(docs): improved readme --- packages/base-configs/README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/packages/base-configs/README.md b/packages/base-configs/README.md index a327416..c9463d9 100644 --- a/packages/base-configs/README.md +++ b/packages/base-configs/README.md @@ -1,21 +1,35 @@ -# `@ivuorinen/base-configs` +# @ivuorinen/base-configs + +[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link] This is a meta package for all my base configs. You can find all the individual configs in the `packages` folder. -The main reason for this package is to make it easier to use these configs in -other projects, and to update them all at once. No more pull requests to update -all the configs one at a time! +The main reason for this package is to make it easier to use these configs in other projects, and to update them all at once. No more pull requests to update all the configs one at a time! ## Installation ```bash +# npm npm install @ivuorinen/base-configs --save-dev +# yarn yarn add @ivuorinen/base-configs --dev ``` +## Changelog + +See [CHANGELOG][changelog-link] for a human-readable history of changes. + ## License -MIT License. See [LICENSE](LICENSE) for more info. +MIT License. See [LICENSE][license-link] for more info. + +[changelog-link]: ./CHANGELOG.md +[license-badge]: https://img.shields.io/github/license/ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399 +[license-link]: ./LICENSE +[npm-badge]: https://img.shields.io/npm/v/@ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399 +[npm-link]: https://www.npmjs.com/package/@ivuorinen/base-configs +[style-badge]: https://img.shields.io/badge/code_style-ivuorinen%E2%80%99s-663399.svg?labelColor=292a44&style=flat-square +[style-link]: https://github.com/ivuorinen/base-configs