mirror of
https://github.com/ivuorinen/base-configs.git
synced 2026-03-10 14:57:48 +00:00
chore(docs): improved readme
This commit is contained in:
@@ -1,21 +1,35 @@
|
|||||||
# `@ivuorinen/base-configs`
|
# @ivuorinen/base-configs <!-- omit in toc -->
|
||||||
|
|
||||||
|
[![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.
|
This is a meta package for all my base configs.
|
||||||
|
|
||||||
You can find all the individual configs in the `packages` folder.
|
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
|
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!
|
||||||
other projects, and to update them all at once. No more pull requests to update
|
|
||||||
all the configs one at a time!
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# npm
|
||||||
npm install @ivuorinen/base-configs --save-dev
|
npm install @ivuorinen/base-configs --save-dev
|
||||||
|
|
||||||
|
# yarn
|
||||||
yarn add @ivuorinen/base-configs --dev
|
yarn add @ivuorinen/base-configs --dev
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
See [CHANGELOG][changelog-link] for a human-readable history of changes.
|
||||||
|
|
||||||
## License
|
## 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
|
||||||
|
|||||||
Reference in New Issue
Block a user