From 6b58212de89fcc115ce1e676a2ed2556a3cdc04d Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Thu, 28 Mar 2024 07:21:56 +0200 Subject: [PATCH] chore(docs): readme tweaks and cleanup --- packages/browserslist-config/README.md | 27 ++-------------------- packages/eslint-config/README.md | 5 +--- packages/markdownlint-config/README.md | 4 +--- packages/prettier-config/README.md | 7 ++---- packages/semantic-release-config/README.md | 8 +++---- packages/stylelint-config/README.md | 5 +--- 6 files changed, 10 insertions(+), 46 deletions(-) diff --git a/packages/browserslist-config/README.md b/packages/browserslist-config/README.md index 9357d74..93e2da9 100644 --- a/packages/browserslist-config/README.md +++ b/packages/browserslist-config/README.md @@ -7,8 +7,6 @@ ## Table of Contents - [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 diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md index 8000fc5..d673049 100644 --- a/packages/eslint-config/README.md +++ b/packages/eslint-config/README.md @@ -1,8 +1,6 @@ # @ivuorinen/eslint-config -[![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 diff --git a/packages/markdownlint-config/README.md b/packages/markdownlint-config/README.md index a164bd7..ddcc511 100644 --- a/packages/markdownlint-config/README.md +++ b/packages/markdownlint-config/README.md @@ -1,8 +1,6 @@ # @ivuorinen/markdownlint-config -[![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]. diff --git a/packages/prettier-config/README.md b/packages/prettier-config/README.md index 2cf333d..de7aa51 100644 --- a/packages/prettier-config/README.md +++ b/packages/prettier-config/README.md @@ -1,8 +1,6 @@ # @ivuorinen/prettier-config -[![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 > } > ``` diff --git a/packages/semantic-release-config/README.md b/packages/semantic-release-config/README.md index 19c74cc..2038429 100644 --- a/packages/semantic-release-config/README.md +++ b/packages/semantic-release-config/README.md @@ -1,8 +1,6 @@ # @ivuorinen/semantic-release-config -[![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 diff --git a/packages/stylelint-config/README.md b/packages/stylelint-config/README.md index 1053ad4..b319ec5 100644 --- a/packages/stylelint-config/README.md +++ b/packages/stylelint-config/README.md @@ -1,8 +1,6 @@ # @ivuorinen/stylelint-config -[![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