diff --git a/README.md b/README.md index 634c37f..46285bb 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,76 @@ Several things will happen if one elects to continue: git push --atomic origin refs/heads/master refs/tags/v0.6.1 env VERSION=0.6.1 PREVIOUS_VERSION=0.6.0 bash -c 'npm publish' -xyz accepts several optional arguments, described in the help text: +## Usage - $ xyz --help + Usage: xyz [options] -### Integration + Publish a new version of the npm package in the current working directory. + This involves updating the version number in package.json, committing this + change (along with any staged changes), tagging the commit, pushing to the + remote git repository, and finally publishing to the public npm registry. + + Options: + + -b --branch + Specify the branch from which new versions must be published. + xyz aborts if run from any other branch to prevent accidental + publication of feature branches. 'master' is assumed if this + option is omitted. + + -e --edit + Allow the commit message to be edited before the commit is made. + + -i --increment + Specify the level of the current version number to increment. + Valid levels: 'major', 'minor', 'patch', 'premajor', 'preminor', + 'prepatch', and 'prerelease'. 'patch' is assumed if this option + is omitted. + + -m --message