update readme

This commit is contained in:
Conduitry 2018-10-04 11:01:32 -04:00
parent d7c27e289f
commit a92b9a47d8
1 changed files with 2 additions and 2 deletions

View File

@ -8,12 +8,12 @@ Managing npm registries sucks. If you're thinking about running one, then you al
## How
This creates and tags a dangling commit off HEAD that includes only the files that would be included in `npm publish`. In the tagged commit, it also removes the `prepare` script from `package.json` if present - the assumption being that this would build the project if someone were installing from your source files, and what we're tagging is already the built files.
This creates and tags an orphaned commit that includes only the files that would be included in `npm publish`. In the tagged commit, it also removes the `prepare` script from `package.json` if present - the assumption being that this would build the project if someone were installing from your source files, and what we're tagging is already the built files.
## Usage
1. Make sure you're ready to go. The `version` field in your `package.json` should be already incremented, and the `files` field should point to everything you want to publish.
1. Run `npm2git.sh`. This creates the commit off HEAD and tags it `vX.X.X`, but does not push it. Inspect the tag to make sure all seems well.
1. Run `npm2git.sh`. This creates the orphaned commit and tags it `vX.X.X`, but does not push it. Inspect the tag to make sure all seems well.
1. Push the tag.
## Installing from Git