Skip to content

Commit

Permalink
style(docs): format README and FAQ with Prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
freshgum-bubbles committed Oct 24, 2023
1 parent 5fd3677 commit 732562f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
>
> <sup>See [*Why does the package not support Node versions under v15.3.0?*][pkg-faq-node-15-3-0].</sup>
>
> <sup>See [_Why does the package not support Node versions under v15.3.0?_][pkg-faq-node-15-3-0].</sup>
> **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)

Expand Down

0 comments on commit 732562f

Please sign in to comment.