docs(meta): Add links to npm.im/lerna to READMEs that lacked it

lerna · Feb 15, 2019 · 4fe2a66 · 4fe2a66
1 parent abeb4dc
commit 4fe2a66
Show file tree

Hide file tree

Showing 26 changed files with 56 additions and 6 deletions.
diff --git a/commands/add/README.md b/commands/add/README.md
@@ -2,6 +2,8 @@
 
 > Add a dependency to matched packages
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/commands/bootstrap/README.md b/commands/bootstrap/README.md
@@ -2,6 +2,8 @@
 
 > Link local packages together and install remaining package dependencies
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/commands/changed/README.md b/commands/changed/README.md
@@ -2,6 +2,8 @@
 
 > List local packages that have changed since the last tagged release
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 The output of `lerna changed` is a list of packages that would be the subjects of the next `lerna version` or `lerna publish` execution.

diff --git a/commands/clean/README.md b/commands/clean/README.md
@@ -2,6 +2,8 @@
 
 > Remove the node_modules directory from all packages
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/commands/create/README.md b/commands/create/README.md
@@ -2,6 +2,8 @@
 
 > Create a new lerna-managed package
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```

diff --git a/commands/diff/README.md b/commands/diff/README.md
@@ -2,6 +2,8 @@
 
 > Diff all packages or a single package since the last release
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/commands/exec/README.md b/commands/exec/README.md
@@ -2,6 +2,8 @@
 
 > Execute an arbitrary command in each package
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/commands/import/README.md b/commands/import/README.md
@@ -2,6 +2,8 @@
 
 > Import a package into the monorepo with commit history
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh
@@ -17,7 +19,7 @@ repo. Each commit is modified to make changes relative to the package
 directory. So, for example, the commit that added `package.json` will
 instead add `packages/<directory-name>/package.json`.
 
-*Note*: If you're importing an external repository on a new lerna repository, then do remember to have at least one commit.
+_Note_: If you're importing an external repository on a new lerna repository, then do remember to have at least one commit.
 
 ```bash
 # Getting started with Lerna

diff --git a/commands/init/README.md b/commands/init/README.md
@@ -2,6 +2,8 @@
 
 > Create a new Lerna repo or upgrade an existing repo to the current version of Lerna
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/commands/link/README.md b/commands/link/README.md
@@ -2,6 +2,8 @@
 
 > Symlink together all packages that are dependencies of each other
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/commands/list/README.md b/commands/list/README.md
@@ -2,6 +2,8 @@
 
 > List local packages
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 The `list` subcommand is aliased to several convenient shorthands (similar to [`npm ls`](https://docs.npmjs.com/cli/ls)):

diff --git a/commands/publish/README.md b/commands/publish/README.md
@@ -2,6 +2,8 @@
 
 > Publish packages in the current project
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/commands/run/README.md b/commands/run/README.md
@@ -2,6 +2,8 @@
 
 > Run an npm script in each package that contains that script
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Usage
 
 ```sh

diff --git a/core/child-process/README.md b/core/child-process/README.md
@@ -5,3 +5,5 @@
 ## Usage
 
 You probably shouldn't.
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/core/filter-options/README.md b/core/filter-options/README.md
@@ -2,6 +2,8 @@
 
 > Options for lerna sub-commands that need filtering
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 ## Options
 
 ### `--scope <glob>`

diff --git a/core/lerna/README.md b/core/lerna/README.md
@@ -15,3 +15,7 @@
 ## Usage
 
 Check out our documentation [here](https://github.com/lerna/lerna#readme).
+
+```sh
+npm i -D lerna
+```
diff --git a/utils/check-working-tree/README.md b/utils/check-working-tree/README.md
@@ -21,3 +21,5 @@ const options = {
   }
 })();
 ```
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/utils/describe-ref/README.md b/utils/describe-ref/README.md
@@ -26,4 +26,6 @@ const result = describe.parse("v1.0.0-5-gdeadbeef");
 // { lastTagName, lastVersion, refCount, sha, isDirty }
 ```
 
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
+
 [git describe]: https://git-scm.com/docs/git-describe
diff --git a/utils/get-packed/README.md b/utils/get-packed/README.md
@@ -4,8 +4,6 @@
 
 ## Usage
 
-```
-const getPacked = require('@lerna/get-packed');
+You probably shouldn't, at least directly.
 
-// TODO: DEMONSTRATE API
-```
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/utils/has-npm-version/README.md b/utils/has-npm-version/README.md
@@ -20,3 +20,5 @@ const predicate = hasNpmVersion.makePredicate();
 // `npm --version` === 6.3.0
 hasNpmVersion(">=5"); // => true
 ```
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/utils/listable/README.md b/utils/listable/README.md
@@ -23,3 +23,5 @@ exports.builder = yargs => {
   listable.options(yargs);
 };
 ```
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/utils/log-packed/README.md b/utils/log-packed/README.md
@@ -15,3 +15,5 @@ execa("npm", ["pack", "--json"]).then(result => {
   tarballs.forEach(logPacked);
 });
 ```
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/utils/map-to-registry/README.md b/utils/map-to-registry/README.md
@@ -17,3 +17,5 @@ const { uri, auth } = mapToRegistry("my-package", config);
 ```
 
 `uri` and `auth` are suitable for arguments to [npm-registry-client](https://www.npmjs.com/package/npm-registry-client) instance method parameters.
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/utils/npm-conf/README.md b/utils/npm-conf/README.md
@@ -5,3 +5,5 @@
 ## Usage
 
 See [npm-conf](https://github.com/kevva/npm-conf#readme)
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/utils/pack-directory/README.md b/utils/pack-directory/README.md
@@ -6,4 +6,6 @@ This package owes an immense debt of gratitude to [Kat Marchán](https://github.
 
 ## Usage
 
-Maybe don't use it, just yet. Here be dragons.
+You probably shouldn't, at least directly.
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
diff --git a/utils/rimraf-dir/README.md b/utils/rimraf-dir/README.md
@@ -11,3 +11,5 @@ rimrafDir("/path/to/directory").then(removedDir => {
   console.log("removed", removedDir);
 });
 ```
+
+Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.