Skip to content

Commit

Permalink
Update docs to include note about submodules & workspaces (#1279)
Browse files Browse the repository at this point in the history
  • Loading branch information
reggi committed Sep 16, 2024
1 parent 7c52403 commit 4f67b3d
Showing 1 changed file with 2 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Git URLs used for npm packages can be formatted in the following ways:

The `commit-ish` can be any tag, sha, or branch that can be supplied as an argument to `git checkout`. The default `commit-ish` is `HEAD`.

Installing any package directly from git will not install [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) or workspaces.

## About modules

A **module** is any file or directory in the `node_modules` directory that can be loaded by the Node.js `require()` function.
Expand Down

0 comments on commit 4f67b3d

Please sign in to comment.