@@ -45,7 +45,7 @@ wraps this utility to figure, for use with [`rehype-meta`][rehype-meta].
45
45
## Install
46
46
47
47
This package is [ ESM only] [ esm ] .
48
- In Node.js (version 14.14+ and or 16.0+), install with [ npm] [ ] :
48
+ In Node.js (version 16.0+), install with [ npm] [ ] :
49
49
50
50
``` sh
51
51
npm install hast-util-reading-time
@@ -61,7 +61,7 @@ In browsers with [`esm.sh`][esmsh]:
61
61
62
62
``` html
63
63
<script type =" module" >
64
- import {readingTime } from " https://esm.sh/hast-util-reading-time@1?bundle"
64
+ import {readingTime } from ' https://esm.sh/hast-util-reading-time@1?bundle'
65
65
</script >
66
66
```
67
67
@@ -99,7 +99,7 @@ It takes about 2-3m to read
99
99
100
100
## API
101
101
102
- This package exports the identifier [ ` readingTime ` ] [ readingtime ] .
102
+ This package exports the identifier [ ` readingTime ` ] [ api-reading-time ] .
103
103
There is no default export.
104
104
105
105
### ` readingTime(tree[, options]) `
@@ -130,7 +130,7 @@ The algorithm works as follows:
130
130
131
131
* ` tree ` ([ ` Node ` ] [ node ] )
132
132
— tree to inspect
133
- * ` options ` ([ ` Options ` ] [ options ] )
133
+ * ` options ` ([ ` Options ` ] [ api- options] , optional )
134
134
— configuration
135
135
136
136
###### Returns
@@ -157,14 +157,17 @@ expect your readers to all be college graduates, etc.
157
157
## Types
158
158
159
159
This package is fully typed with [ TypeScript] [ ] .
160
- It exports the additional type [ ` Options ` ] [ options ] .
160
+ It exports the additional type [ ` Options ` ] [ api- options] .
161
161
162
162
## Compatibility
163
163
164
- Projects maintained by the unified collective are compatible with all maintained
164
+ Projects maintained by the unified collective are compatible with maintained
165
165
versions of Node.js.
166
- As of now, that is Node.js 14.14+ and 16.0+.
167
- Our projects sometimes work with older versions, but this is not guaranteed.
166
+
167
+ When we cut a new major release, we drop support for unmaintained versions of
168
+ Node.
169
+ This means we try to keep the current release line,
170
+ ` hast-util-reading-time@^1 ` , compatible with Node.js 12.
168
171
169
172
## Security
170
173
@@ -205,9 +208,9 @@ abide by its terms.
205
208
206
209
[ downloads ] : https://www.npmjs.com/package/hast-util-reading-time
207
210
208
- [ size-badge ] : https://img.shields.io/bundlephobia/minzip/ hast-util-reading-time.svg
211
+ [ size-badge ] : https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q= hast-util-reading-time
209
212
210
- [ size ] : https://bundlephobia .com/result?p =hast-util-reading-time
213
+ [ size ] : https://bundlejs .com/?q =hast-util-reading-time
211
214
212
215
[ sponsors-badge ] : https://opencollective.com/unified/sponsors/badge.svg
213
216
@@ -265,6 +268,6 @@ abide by its terms.
265
268
266
269
[ martech ] : https://martech.org/estimated-reading-times-increase-engagement/
267
270
268
- [ readingtime ] : #readingtimetree-options
271
+ [ api-reading-time ] : #readingtimetree-options
269
272
270
- [ options ] : #options
273
+ [ api- options] : #options
0 commit comments