aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/packages/turbo-tracing-next-plugin/README.md
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2023-11-03 21:25:40 +0800
committer简律纯 <i@jyunko.cn>2023-11-03 21:25:40 +0800
commit9029588590bea8b10451575c5142dcde77ecd1b5 (patch)
tree04cf8aee56c23fd225ff19d340f7cee621d874ef /packages/turbo-tracing-next-plugin/README.md
parent94071d7ce16c56641d67d488e2bac6be84ffe731 (diff)
downloadHydroRoll-9029588590bea8b10451575c5142dcde77ecd1b5.tar.gz
HydroRoll-9029588590bea8b10451575c5142dcde77ecd1b5.zip
chore: delete useless files
Diffstat (limited to 'packages/turbo-tracing-next-plugin/README.md')
-rw-r--r--packages/turbo-tracing-next-plugin/README.md39
1 files changed, 0 insertions, 39 deletions
diff --git a/packages/turbo-tracing-next-plugin/README.md b/packages/turbo-tracing-next-plugin/README.md
deleted file mode 100644
index dbd2609..0000000
--- a/packages/turbo-tracing-next-plugin/README.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# `@vercel/experimental-nft-next-plugin`
-
-## Installation
-
-- yarn add -D `@vercel/experimental-nft-next-plugin`
-- npm install -D `@vercel/experimental-nft-next-plugin`
-- pnpm install -D `@vercel/experimental-nft-next-plugin`
-
-## Usage
-
-```js
-// next.config.js
-
-const { createNodeFileTrace } = require("@vercel/experimental-nft-next-plugin");
-
-const withNodeFileTrace = createNodeFileTrace({
- // experimental nft options
- log: {
- all: true,
- },
-});
-
-module.exports = withNodeFileTrace({
- // next config
-});
-```
-
-### experimental nft options
-
-> **Note**
->
-> The default options should work fine.
-
-- `cwd?: string`, default is `process.cwd()`, you can override it to specify another directory to run experimental nft.
-- `contextDirectory?: string`, relative to cwd, default is `.`. It must be the directory where the `node_modules` directory is located. If you are in the monorepo, you should set it to the root directory of the monorepo. For yarn2+/npm workspaces, the default value will respect the `PROJECT_CWD` and `npm_config_local_prefix` environment variables injected by yarn/npm client. If the default value doesn't work, you can override it to specify the root directory of the monorepo.
-- `path?: string`, additional path which will be appended into the `PATH` environment variable.
-- `log?.all?: boolean`, default is `false`, whether to show all logs.
-- `log?.level?: string`, default is `error`, the log level.
-- `log?.detail?: boolean`, default is `false`, whether to expand the log details.