From 0ff928bc623ef7560c38c02c7ca34387653cafe5 Mon Sep 17 00:00:00 2001 From: neeboo Date: Wed, 4 Dec 2019 16:50:28 +0800 Subject: [PATCH] chore(README):fix README.md --- README.md | 45 ++++++++++++++++++++++++++++++++++++++------- 1 file changed, 38 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1c165fd..eb11e90 100644 --- a/README.md +++ b/README.md @@ -267,20 +267,51 @@ yarn build && yarn test:e2e The packages is to be published to npm, using `@next` tag using script in `package.json` +Follow steps below to publish a npm verion using `@next` tag + 1. Commit all changes to github master 2. Run publish script - ```bash - yarn dev:publish - ``` -3. Confirm all prompt with `Y` + +```bash + yarn dev:publish +``` + +3. Select version and confirm all prompts with `Y` 4. See version changes in `npmjs.com` +This will not change the release version of current npm packages(currently 0.0.7), developers have to use `@next` to install from npm. + +For example. + +```bash + npm install @harmony-js/core@next +``` + + + ## Publish to npm with `lerna` + +Follow steps below to publish a npm verion with latest version + 1. Commit all changes to github master 2. Run `lerna publish`, `lerna` is required globally. - ```bash - lerna publish - ``` + +```bash + lerna publish +``` +3. Select version and confirm all prompts with `Y` +4. See version changes in `npmjs.com` + +This will change the release version of current npm packages to the latest version, developers can install from npm directly + +For example. + +```bash + npm install @harmony-js/core +``` + + +