Skip to content

Commit

Permalink
docs: update GUIDE.md (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eunjae Lee authored Aug 7, 2019
1 parent 2054b29 commit 7f739b4
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,23 @@

<!-- tocstop -->

## Installation

```bash
npm install --save-dev shipjs

or

yarn add -D shipjs
```

Add the following to the `scripts` section in your `package.json`.

```js
"shipjs:prepare": "shipjs prepare",
"shipjs:release": "shipjs release",
```

## Integrate with Circle CI

A minimal `.circleci/config.yml` looks like the following:
Expand Down Expand Up @@ -140,6 +157,20 @@ When you review and merge the PR, your CI will run `shipjs release` and it will

You see the slight difference between two strategies?

### Release projects somewhere other than NPM

You can use Ship.js to release projects somewhere other than NPM.

For example,

```js
module.exports = {
publishCommand: () => "npx now"
};
```

By default, `publishCommand` returns `yarn publish` or `npm publish`. You can override it like the above to release it to wherever you want.

## All Configurations

[See here for all configurations](./CONFIG.md)
Expand Down

0 comments on commit 7f739b4

Please sign in to comment.