Skip to content

Commit

Permalink
removed outdated how-it-works
Browse files Browse the repository at this point in the history
  • Loading branch information
hunterloftis committed Jun 23, 2015
1 parent c6e84ec commit efeeef4
Showing 1 changed file with 0 additions and 19 deletions.
19 changes: 0 additions & 19 deletions README.md
Expand Up @@ -4,24 +4,6 @@

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.


## How it Works

Apps are built via one of four paths:

1. A regular `npm install` (first build; default scenario)
2. Copy existing `node_modules` from cache, then `npm prune`, then `npm install` (subsequent builds)
3. Skip dependencies (if package.json doesn't exist but server.js does)
4. Skip cache, run `npm rebuild` before `npm install` (`node_modules` are checked into source control)

You should only use #3 (omitting package.json) for quick tests or experiments.

You should never use #4 - it's included for backwards-compatibility and will generate warnings.
**Checking in `node_modules` is an antipattern.**
For more information, see [the npm docs](https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git-)

For technical details, check out the [heavily-commented compile script](https://github.com/heroku/heroku-buildpack-nodejs/blob/master/bin/compile).

## Documentation

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


## Locking to a buildpack version

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

0 comments on commit efeeef4

Please sign in to comment.