Merge pull request #101 from gperl27/patch-1

docs: Add yarn workspaces example
pmowrer · Feb 22, 2021 · 413a570 · 413a570
2 parents ea4773d + 844a230
commit 413a570
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ npm install -D semantic-release semantic-release-monorepo
 
 ## Usage
 
-Run `semantic-release` in the **root of a monorepo package** and apply `semantic-release-monorepo` via the [`extends`](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#extends) option.
+Run `semantic-release` in an **individual monorepo package** and apply `semantic-release-monorepo` via the [`extends`](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#extends) option.
 
 On the command line:
 ```bash
@@ -50,6 +50,12 @@ NOTE: This library **CAN'T** be applied via the `plugins` option.
 }
 ```
 
+### With Yarn Workspaces
+
+```bash
+$ yarn workspaces run semantic-release -e semantic-release-monorepo
+```
+
 ### With Lerna
 The monorepo management tool [`lerna`](https://github.com/lerna/lerna) can be used to run `semantic-release-monorepo` across all packages in a monorepo with a single command: