Skip to content

Commit 8653a7b

Browse files
Merge pull request #128 from HarperDB/update-install-docs
update install docs
2 parents dbe0ced + 7d1b1fe commit 8653a7b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/developers/components/installing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ myComponentName:
1212
package: HarperDB-Add-Ons/package
1313
```
1414
15-
Under the hood HarperDB is calling npm install on all components, this means that the package value can be any valid npm reference such as a GitHub repo, an NPM package, a tarball, a local directory or a website.
15+
Under the hood HarperDB is calling `npm install` on all components, this means that the package value can be any valid npm reference such as a GitHub repo, an npm package, a tarball, a local directory, or a website.
1616

1717
```yaml
1818
myGithubComponent:
1919
package: HarperDB-Add-Ons/package#v2.2.0 # install from GitHub
2020
myNPMComponent:
21-
package: harperdb # install from NPM
21+
package: harperdb # install from npm
2222
myTarBall:
2323
package: /Users/harper/cool-component.tar # install from tarball
2424
myLocal:
@@ -29,7 +29,7 @@ myWebsite:
2929

3030
When HarperDB is run or restarted it checks to see if there are any new or updated components. If there are, it will dynamically create a package.json file in the `rootPath` directory and call `npm install`.
3131

32-
NPM will install all the components in `<ROOTPATH>/node_moduels`.
32+
npm will install all the components and store them in `<ROOTPATH>/components`. A symlink back to `<ROOTPATH>/node_modules` is also created for dependency resolution purposes.
3333

3434
The package.json file that is created will look something like this.
3535

0 commit comments

Comments
 (0)