Skip to content

Commit

Permalink
README.md: added some basic release strategies for node
Browse files Browse the repository at this point in the history
It appears the release strategies for node's npm is a bit of a
problem. Hence, let's start from customers' instruction.

This patch adds some basic release strategies for node in README.md.

Co-authored-by: Shuralyov, Jean <[email protected]>
Co-authored-by: Galyna, Cory <[email protected]>
Co-authored-by: (Holloway) Chew, Kean Ho <[email protected]>
Signed-off-by: (Holloway) Chew, Kean Ho <[email protected]>
  • Loading branch information
3 people committed Jun 7, 2024
1 parent 8145070 commit 5bde984
Showing 1 changed file with 61 additions and 3 deletions.
64 changes: 61 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,75 @@ This library supports multiple programming languages for the same dataset.
Hence, in order to use it, please import based on your deployed programming
language:



### Javascript Ecosystems

To use `hestiaERROR` library in your Javascript|Typescript project, you may use
the following methods for integrations:


#### Git Release Branches (Recommended)

It's highly recommended to use `git` release branches inside your `package.json`
dependencies list. This is to avoid the registry configurations problem
involving `npm`:

```
{
"dependencies": {
...
"@chewkeanho/hestiaERROR": "git+https://github.com/ChewKeanHo/hestiaERROR.git#[VERSION]_js"
...
}
}
```

For always latest release, the `latest` version tag can be used. Example:

```
{
...
"dependencies": {
...
"@chewkeanho/hestiaERROR": "git+https://github.com/ChewKeanHo/hestiaERROR.git#latest_js"
...
}
...
}
```


#### NPM

> **NOTE**
>
> To be updated.


### Javascript Ecosystems
### Git

#### Git Release Branches (Recommended)
To source the library using `git` directly, simply execute the following
instructions:

```
git clone --single-branch --branch [BRANCH_VERSION]_git https://github.com/ChewKeanHo/hestiaERROR.git
```

For always latest release, use the `main` branch. Example:

```
git clone --single-branch --branch `main` https://github.com/ChewKeanHo/hestiaERROR.git
```

> **NOTE**
>
> 1. Branches like `next` and `experimental` are for package maintainers and
> development. Only use it at your own risk.
> 2. `next` branch simply means the next release version.
> 3. `experimental` is for maintainers' development.
#### NPM



Expand Down

0 comments on commit 5bde984

Please sign in to comment.