Add documentation for running local generators (yeoman#547)

ryanvanoss · Nov 1, 2017 · 77bdb9b · 77bdb9b
1 parent ab77908
commit 77bdb9b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/lib/usage.txt b/lib/usage.txt
@@ -15,6 +15,12 @@ Install a generator:
   $ npm install generator-angular
   $ yo angular --help
 
+Run local generators:
+
+  Additionally, you can also run local generators without installing via npm.
+
+  $ yo ./path/to/some/generator
+
 Completion:
 
   To enable shell completion for the yo command, try running

diff --git a/readme.md b/readme.md
@@ -27,6 +27,12 @@ yo webapp
 
 *To create and distribute your own generator, refer to [our official documentation](http://yeoman.io/authoring/)*
 
+You can also run a local generator on your computer as such:
+
+```sh
+# Running a local generator
+yo ./path/to/local/generator
+```
 
 ## Options