ivuorinen/base-configs
1
0
Fork 0
mirror of https://github.com/ivuorinen/base-configs.git synced 2026-01-26 03:03:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): readme tweaks and cleanup

Browse Source
This commit is contained in:
Ismo Vuorinen
2024-03-28 07:21:56 +02:00
parent 8ceee3e908
commit 6b58212de8
6 changed files with 10 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
packages/browserslist-config/README.md
View File

@@ -7,8 +7,6 @@
## Table of Contents <!-- omit in toc -->
- [Supported Browsers](#supported-browsers)
- [Desktop Browsers](#desktop-browsers)
- [Mobile Browsers](#mobile-browsers)
- [Installation](#installation)
- [Documentations](#documentations)
- [Contributing](#contributing)
@@ -17,19 +15,9 @@
## Supported Browsers
### Desktop Browsers
> 'defaults and fully supports es6-module', 'maintained node versions'
| [![Chrome][chrome-image]][browsers-badges-link] | [![Edge][edge-image]][browsers-badges-link] | [![Firefox][firefox-image]][browsers-badges-link] | [![Opera][opera-image]][browsers-badges-link] | [![Safari][safari-image]][browsers-badges-link] |
| :---------------------------------------------: | :-----------------------------------------: | :-----------------------------------------------: | :-------------------------------------------: | :---------------------------------------------: |
| Chrome | Edge | Firefox | Opera | Safari |
| >= 60 | last 2 | >= 60 | last 2 | >= 12 |
### Mobile Browsers
| [![Android WebView][android-webview-image]][browsers-badges-link] | [![Chrome][chrome-image]][browsers-badges-link] | [![Firefox][firefox-image]][browsers-badges-link] | [![Opera Mini][opera-mini-image]][browsers-badges-link] | [![Safari iOS][safari-ios-image]][browsers-badges-link] | [![Samsung Internet][samsung-internet-image]][browsers-badges-link] | [![UC][uc-image]][browsers-badges-link] |
| :---------------------------------------------------------------: | :---------------------------------------------: | :-----------------------------------------------: | :-----------------------------------------------------: | :-----------------------------------------------------: | :-----------------------------------------------------------------: | :-------------------------------------: |
| Android WebView | Chrome | Firefox | Opera Mini | Safari iOS | Samsung Internet | UC |
| last 2 | last 2 | last 2 | last 2 | >= 12 | last 2 | last 2 |
See the up to date list of supported browsers in the [Browserslist docs](https://browsersl.ist/#q=%22browserslist%22%3A+%5B%0A++%22defaults+and+fully+supports+es6-module%22%2C%0A++%22maintained+node+versions%22%0A%5D).
## Installation
@@ -77,14 +65,3 @@ Distributed under the MIT License. See [LICENSE][license-link] for more informat
[pull-request-link]: https://github.com/ivuorinen/base-configs/pulls
[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
[browsers-badges-link]: https://github.com/alrra/browser-logos
[android-webview-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/android-webview/android-webview_48x48.png
[chrome-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/chrome/chrome_48x48.png
[edge-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/edge/edge_48x48.png
[firefox-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/firefox/firefox_48x48.png
[opera-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/opera/opera_48x48.png
[opera-mini-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/opera-mini/opera-mini_48x48.png
[safari-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/safari/safari_48x48.png
[safari-ios-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/safari-ios/safari-ios_48x48.png
[samsung-internet-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/samsung-internet/samsung-internet_48x48.png
[uc-image]: https://raw.githubusercontent.com/alrra/browser-logos/main/src/uc/uc_48x48.png

5
packages/eslint-config/README.md
View File

@@ -1,8 +1,6 @@
# @ivuorinen/eslint-config <!-- omit in toc -->
[![npm package][npm-badge]][npm-link]
[![license MIT][license-badge]][license-link]
[![ivuorinen's Code Style][style-badge]][style-link]
[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link]
> ivuorinen's shareable configuration for [`ESLint`][eslint-link].
@@ -76,5 +74,4 @@ Distributed under the MIT License. See [LICENSE][license-link] for more informat
[pull-request-link]: https://github.com/ivuorinen/base-configs/pulls
[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
[jest-link]: https://jestjs.io

4
packages/markdownlint-config/README.md
View File

@@ -1,8 +1,6 @@
# @ivuorinen/markdownlint-config <!-- omit in toc -->
[![npm package][npm-badge]][npm-link]
[![license MIT][license-badge]][license-link]
[![code style][style-badge]][style-link]
[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![code style][style-badge]][style-link]
> ivuorinen's shareable configuration for [`MarkdownLint`][markdownlint-link].

7
packages/prettier-config/README.md
View File

@@ -1,8 +1,6 @@
# @ivuorinen/prettier-config <!-- omit in toc -->
[![npm package][npm-badge]][npm-link]
[![license MIT][license-badge]][license-link]
[![ivuorinen's Code Style][style-badge]][style-link]
[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link]
> ivuorinen's shareable configuration for [`Prettier`][prettier-link].
@@ -37,8 +35,7 @@ After installing it, a _`.prettierrc.json`_ file will be created automatically i
> ```js
> module.exports = {
> ...require('@ivuorinen/prettier-config'),
>
> // Add custom options bellow:
> // Add custom options below:
> semi: true
> }
> ```

8
packages/semantic-release-config/README.md
View File

@@ -1,8 +1,6 @@
# @ivuorinen/semantic-release-config <!-- omit in toc -->
[![npm package][npm-badge]][npm-link]
[![license MIT][license-badge]][license-link]
[![ivuorinen's Code Style][style-badge]][style-link]
[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link]
> ivuorinen's shareable configuration for [`semantic-release`][semantic-release-link].
@@ -82,8 +80,8 @@ jobs:
uses: actions/setup-node@v2.1.5
with:
always-auth: true
node-version: 14
registry-url: "https://registry.npmjs.org"
node-version: 20
registry-url: 'https://registry.npmjs.org'
- name: Install Dependencies with Caching
uses: bahmutov/npm-install@v1.6.0

5
packages/stylelint-config/README.md
View File

@@ -1,8 +1,6 @@
# @ivuorinen/stylelint-config <!-- omit in toc -->
[![npm package][npm-badge]][npm-link]
[![license MIT][license-badge]][license-link]
[![ivuorinen's Code Style][style-badge]][style-link]
[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link]
> ivuorinen's shareable configuration for [`stylelint`][stylelint-link].
@@ -74,7 +72,6 @@ The defined rules can be modified by adding other configurations, plugins or cus
]
}
}
```
## Documentations