@turbo/gen 1.9.6 → 1.9.7

package/README.md

@@ -1,66 +1,38 @@
 # `@turbo/gen`
 
-> This package is currently in **beta**. Please report any issues you encounter, and give us feedback about your experience using it!
-
-Easily extend your Turborepo with new apps, and packages. Create new empty workspaces, copy existing workspaces, add workspaces from remote sources (just like `create-turbo`!) or run custom generators defined using [Plop](https://plopjs.com/) configurations.
+Types for working with [Turborepo Generators](https://turbo.build/repo/docs/core-concepts/monorepos/code-generation).
 
 ## Usage
 
-```bash
-Usage: @turbo/gen [options] [command]
-
-Extend your Turborepo
-
-Options:
-  -v, --version                          Output the current version
-  -h, --help                             Display help for command
-
-Commands:
-  add|a [options]                        Add a new package or app to your project
-  generate|g [options] [generator-name]  Run custom generators
-  help [command]                         display help for command
-```
-
-## Add
-
-Extend your Turborepo with new apps or packages. Create new empty workspaces, copy existing workspaces, or add workspaces from remote sources (just like `create-turbo`!).
-
-### Usage
-
-#### Blank Workspace
+Install:
 
 ```bash
-@turbo/gen add
+pnpm add @turbo/gen --save-dev
 ```
 
-#### Copy a Local Workspace
-
-```bash
-@turbo/gen add --copy
+Use types within your generator `config.ts`:
+
+```ts filename="turbo/generators/config.ts"
+import type { PlopTypes } from "@turbo/gen";
+
+export default function generator(plop: PlopTypes.NodePlopAPI): void {
+  // create a generator
+  plop.setGenerator("Generator name", {
+    description: "Generator description",
+    // gather information from the user
+    prompts: [
+      ...
+    ],
+    // perform actions based on the prompts
+    actions: [
+      ...
+    ],
+  });
+}
 ```
 
-#### Copy a Remote Workspace
+Learn more about Turborepo Generators in the [docs](https://turbo.build/repo/docs/core-concepts/monorepos/code-generation)
 
-```bash
-@turbo/gen add -e <git-url>
-```
-
-## Generate
-
-Extend your Turborepo with custom generators defined using [Plop](https://plopjs.com/) configurations.
-
-### Usage
-
-```bash
-@turbo/gen generate [generator-name]
-```
-
-### Writing Generators
-
-`@turbo/gen` will search the root of your monorepo, and every workspace for generators defined at:
-
-```bash
-turbo/generators/config.js
-```
+---
 
-**NOTE**: By default, generators are run from the _root_ of the _workspace_ where they are defined.
+For more information about Turborepo, visit [turbo.build](https://turbo.build) and follow us on Twitter ([@turborepo](https://twitter.com/turborepo))!