From 732562f3425bba3f702416ce849e912b6678bd37 Mon Sep 17 00:00:00 2001 From: freshgum Date: Tue, 24 Oct 2023 18:51:03 +0100 Subject: [PATCH] style(docs): format README and FAQ with Prettier --- FAQ.md | 4 ++-- README.md | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/FAQ.md b/FAQ.md index dafae834..b96c190f 100644 --- a/FAQ.md +++ b/FAQ.md @@ -2,10 +2,10 @@ ## Why does the package not support Node versions under v15.3.0? -That version is the first version to introduce fully-fledged support for ES Modules (see [*Modules: ECMAScript modules*][nodejs-docs-esm]). +That version is the first version to introduce fully-fledged support for ES Modules (see [_Modules: ECMAScript modules_][nodejs-docs-esm]). It's also [three years old](https://nodejs.org/download/release/v15.3.0/), which provides quite a fair bit of backwards compatibility. -The usage of TypeDI++ with versions *older* than 15.3.0 may be achieved via external packages such as [ESM][npm-esm], though +The usage of TypeDI++ with versions _older_ than 15.3.0 may be achieved via external packages such as [ESM][npm-esm], though this would not be an officially supported scenario, and any issues caused as a result of the old Node version would not be fixed. [nodejs-docs-esm]: https://nodejs.org/docs/latest/api/esm.html diff --git a/README.md b/README.md index 1a1b3689..924106db 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,10 @@ > **Warning** > From 0.4.0, support for Node versions under v15.3.0 has been removed, as the package has transitioned to ES Modules. -> -> See [*Why does the package not support Node versions under v15.3.0?*][pkg-faq-node-15-3-0]. +> +> See [_Why does the package not support Node versions under v15.3.0?_][pkg-faq-node-15-3-0]. -> **Note** -> [Experimental support for Bun has also been introduced](https://github.com/freshgum-bubbles/typedi/commit/f2ec73a6fe1598122cf64f7097a77910fab13560). Feel free to test and report any issues! +> **Note** > [Experimental support for Bun has also been introduced](https://github.com/freshgum-bubbles/typedi/commit/f2ec73a6fe1598122cf64f7097a77910fab13560). Feel free to test and report any issues! ![GitHub](https://img.shields.io/github/license/freshgum-bubbles/typedi) ![npm (scoped)](https://img.shields.io/npm/v/@freshgum/typedi) [![Website](https://img.shields.io/website/https/64a0c6b5de74517c4c7bdb77--singular-praline-356e00.netlify.app.svg?logo=BookStack&label=Documentation&labelColor=177C28)][docs-site] ![Maintenance](https://img.shields.io/maintenance/yes/2023)