Skip to content

Commit 6bead30

Browse files
committed
chore: update readme
1 parent d3f3d72 commit 6bead30

File tree

2 files changed

+21
-53
lines changed

2 files changed

+21
-53
lines changed

README.md

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!-- automd:badges color=yellow codecov bundlejs -->
44

55
[![npm version](https://img.shields.io/npm/v/rc9?color=yellow)](https://npmjs.com/package/rc9)
6-
[![npm downloads](https://img.shields.io/npm/dm/rc9?color=yellow)](https://npmjs.com/package/rc9)
6+
[![npm downloads](https://img.shields.io/npm/dm/rc9?color=yellow)](https://npm.chart.dev/rc9)
77
[![bundle size](https://img.shields.io/bundlejs/size/rc9?color=yellow)](https://bundlejs.com/?q=rc9)
88
[![codecov](https://img.shields.io/codecov/c/gh/unjs/rc9?color=yellow)](https://codecov.io/gh/unjs/rc9)
99

@@ -28,19 +28,22 @@ npm install rc9
2828
yarn add rc9
2929

3030
# pnpm
31-
pnpm install rc9
31+
pnpm add rc9
3232

3333
# bun
3434
bun install rc9
35+
36+
# deno
37+
deno install npm:rc9
3538
```
3639

3740
<!-- /automd -->
3841

3942
Import utils:
4043

41-
<!-- automd:jsimport cjs src="./src/index.ts"-->
44+
<!-- automd:jsimport src="./src/index.ts"-->
4245

43-
**ESM** (Node.js, Bun)
46+
**ESM** (Node.js, Bun, Deno)
4447

4548
```js
4649
import {
@@ -49,35 +52,15 @@ import {
4952
parseFile,
5053
read,
5154
readUser,
52-
readUserConfig,
5355
serialize,
5456
write,
5557
writeUser,
56-
writeUserConfig,
57-
update,
58-
updateUser,
59-
updateUserConfig,
60-
} from "rc9";
61-
```
62-
63-
**CommonJS** (Legacy Node.js)
64-
65-
```js
66-
const {
67-
defaults,
68-
parse,
69-
parseFile,
70-
read,
71-
readUser,
7258
readUserConfig,
73-
serialize,
74-
write,
75-
writeUser,
7659
writeUserConfig,
60+
updateUserConfig,
7761
update,
7862
updateUser,
79-
updateUserConfig,
80-
} = require("rc9");
63+
} from "rc9";
8164
```
8265

8366
<!-- /automd -->
@@ -160,17 +143,11 @@ const defaults: RCOptions;
160143
function parse(contents: string, options?: RCOptions): RC;
161144
function parseFile(path: string, options?: RCOptions): RC;
162145
function read(options?: RCOptions | string): RC;
163-
/** @deprecated Use `readUserConfig` */
164-
function readUser(options?: RCOptions | string): RC;
165146
function readUserConfig(options?: RCOptions | string): RC;
166147
function serialize(config: RC): string;
167148
function write(config: RC, options?: RCOptions | string): void;
168-
/** @deprecated Use `writeUserConfig` */
169-
function writeUser(config: RC, options?: RCOptions | string): void;
170149
function writeUserConfig(config: RC, options?: RCOptions | string): void;
171150
function update(config: RC, options?: RCOptions | string): RC;
172-
/** @deprecated Use `updateUserConfig` */
173-
function updateUser(config: RC, options?: RCOptions | string): RC;
174151
function updateUserConfig(config: RC, options?: RCOptions | string): RC;
175152
```
176153

pnpm-lock.yaml

Lines changed: 12 additions & 21 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)