Skip to content

Commit efeeef4

Browse files
committed
removed outdated how-it-works
1 parent c6e84ec commit efeeef4

File tree

1 file changed

+0
-19
lines changed

1 file changed

+0
-19
lines changed

README.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,6 @@
44

55
This is the official [Heroku buildpack](http://devcenter.heroku.com/articles/buildpacks) for Node.js apps. If you fork this repository, please **update this README** to explain what your fork does and why it's special.
66

7-
8-
## How it Works
9-
10-
Apps are built via one of four paths:
11-
12-
1. A regular `npm install` (first build; default scenario)
13-
2. Copy existing `node_modules` from cache, then `npm prune`, then `npm install` (subsequent builds)
14-
3. Skip dependencies (if package.json doesn't exist but server.js does)
15-
4. Skip cache, run `npm rebuild` before `npm install` (`node_modules` are checked into source control)
16-
17-
You should only use #3 (omitting package.json) for quick tests or experiments.
18-
19-
You should never use #4 - it's included for backwards-compatibility and will generate warnings.
20-
**Checking in `node_modules` is an antipattern.**
21-
For more information, see [the npm docs](https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git-)
22-
23-
For technical details, check out the [heavily-commented compile script](https://github.com/heroku/heroku-buildpack-nodejs/blob/master/bin/compile).
24-
257
## Documentation
268

279
For more information about using Node.js and buildpacks on Heroku, see these Dev Center articles:
@@ -32,7 +14,6 @@ For more information about using Node.js and buildpacks on Heroku, see these Dev
3214
- [Buildpacks](https://devcenter.heroku.com/articles/buildpacks)
3315
- [Buildpack API](https://devcenter.heroku.com/articles/buildpack-api)
3416

35-
3617
## Locking to a buildpack version
3718

3819
In production, you frequently want to lock all of your dependencies - including

0 commit comments

Comments
 (0)