ivuorinen/base-configs
1
0
Fork 0
mirror of https://github.com/ivuorinen/base-configs.git synced 2026-02-04 20:43:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): improved readme

Browse Source
This commit is contained in:
Ismo Vuorinen
2023-10-31 11:22:41 +02:00
parent 1a47cca54c
commit 58812035c1
1 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
packages/base-configs/README.md
View File

@@ -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.
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