aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/packages/turbo-workspaces/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-workspaces/README.md
parent94071d7ce16c56641d67d488e2bac6be84ffe731 (diff)
downloadHydroRoll-9029588590bea8b10451575c5142dcde77ecd1b5.tar.gz
HydroRoll-9029588590bea8b10451575c5142dcde77ecd1b5.zip
chore: delete useless files
Diffstat (limited to 'packages/turbo-workspaces/README.md')
-rw-r--r--packages/turbo-workspaces/README.md49
1 files changed, 0 insertions, 49 deletions
diff --git a/packages/turbo-workspaces/README.md b/packages/turbo-workspaces/README.md
deleted file mode 100644
index 60d8024..0000000
--- a/packages/turbo-workspaces/README.md
+++ /dev/null
@@ -1,49 +0,0 @@
-# `@turbo/workspaces`
-
-Easily convert your repo between package managers. Supports both non-monorepos and monorepos (using package manager workspaces).
-
-## CLI
-
-```sh
-Usage: @turbo/workspaces [options] [command]
-
-Tools for working with package manager workspaces
-
-Options:
- -v, --version output the current version
- -h, --help display help for command
-
-Commands:
- convert [options] [path] [package-manager] Convert project between workspace managers
- summary [path] Display a summary of the specified project
- help [command] display help for command
-```
-
-## Node API
-
-Methods are also available via the Node API:
-
-```js
-import { convert, getWorkspaceDetails } from "@turbo/workspaces";
-
-// detect the package manager
-const project = getWorkspaceDetails({
- root: process.cwd(),
-});
-
-// if the package manager is not pnpm, convert to pnpm
-if (project.packageManager !== "pnpm") {
- await convert({
- root: process.cwd(),
- to: "pnpm",
- options: {
- dry: false,
- install: true,
- },
- });
-}
-```
-
----
-
-For more information about Turborepo, visit [turbo.build/repo](https://turbo.build/repo) and follow us on Twitter ([@turborepo](https://twitter.com/turborepo))!