Skip to content

Commit 3c38461

Browse files
Copilottakker99
andcommitted
Add Node.js & npm experimental support notice to README
Co-authored-by: takker99 <37929109+takker99@users.noreply.github.com>
1 parent 1853882 commit 3c38461

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@
44
[![npm](https://img.shields.io/npm/v/@cosense/types)](https://www.npmjs.com/package/@cosense/types)
55
[![test](https://github.com/scrapbox-jp/types/workflows/ci/badge.svg)](https://github.com/scrapbox-jp/types/actions?query=workflow%3Aci)
66

7+
> **Node.js & npm Notice**
8+
>
9+
> Now also published on **[npm](https://www.npmjs.com/package/@cosense/types)**.
10+
>
11+
> Node.js support is **experimental**: I mainly target Deno and browsers, so I
12+
> don't actively maintain Node.js compatibility. Some tests run, but there may
13+
> still be runtime or type gaps remaining. Please use it with that
14+
> understanding.
15+
>
16+
> That said, **issues / PRs to improve Node support are very welcome!**
17+
>
18+
> If you don't need a public npm package, you can consume the JSR version
19+
> directly—`npm` via a custom registry in `.npmrc`; `yarn` or `pnpm` need no
20+
> extra config. See the
21+
> [JSR docs](https://jsr.io/docs/using-packages#adding-a-package).
22+
723
Type definitions for [cosense](https://cosen.se)
824

925
## Getting Started

0 commit comments

Comments
 (0)