@roketus/loyalty-js-sdk 5.4.0 → 5.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.dev.md +29 -0
- package/README.md +4 -6
- package/package.json +3 -2
package/README.dev.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# loyalty-js-sdk
|
|
2
|
+
JS SDK for loyalty API
|
|
3
|
+
|
|
4
|
+
# How to publish package
|
|
5
|
+
|
|
6
|
+
## [OLD for Github Packages]
|
|
7
|
+
Note: This method is deprecated as GitHub Packages requires authentication, which caused access issues.
|
|
8
|
+
+ Generate PAT in your github account page go to `Settings->Developer Setting->Personal Access Token`
|
|
9
|
+
+ Login to your registry
|
|
10
|
+
+ `npm login --scope=@roketus --registry=https://npm.pkg.github.com`
|
|
11
|
+
+ When prompting for a password fill you PAT
|
|
12
|
+
|
|
13
|
+
## [NEW for npmjs]
|
|
14
|
+
The registry for SDK packages has been updated to registry.npmjs.org to resolve access issues, allowing anyone to install the package without specific permissions.
|
|
15
|
+
|
|
16
|
+
1. Login to your registry
|
|
17
|
+
+ `npm login --scope=@roketus --registry=https://registry.npmjs.org/`
|
|
18
|
+
+ When prompted, press ENTER to proceed.
|
|
19
|
+
+ Enter the two-factor authentication code (contact your manager for the code).
|
|
20
|
+
|
|
21
|
+
2. After changes are merged into the `main` branch
|
|
22
|
+
+ `npm version <update_type>` (Replace <update_type> with major | minor | patch as needed.)
|
|
23
|
+
+ `npm publish --access public --registry=https://registry.npmjs.org/`
|
|
24
|
+
+ `git push origin <tag_name>` (Replace <tag_name> with the version tag (e.g., v0.0.0))
|
|
25
|
+
+ `git push origin main`
|
|
26
|
+
|
|
27
|
+
# Installing the SDK
|
|
28
|
+
Once published, the new version of the SDK can be installed in your project using:
|
|
29
|
+
`npm install @roketus/loyalty-js-sdk`
|
package/README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# loyalty-js-sdk
|
|
2
|
-
JS
|
|
2
|
+
JS SDK for loyalty API
|
|
3
3
|
|
|
4
|
-
#
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
+ `npm login --scope=@roketus --registry=https://npm.pkg.github.com`
|
|
8
|
-
+ When prompting for a password fill you PAT
|
|
4
|
+
# Installing the SDK
|
|
5
|
+
The new version of the SDK can be installed in your project using:
|
|
6
|
+
`npm install @roketus/loyalty-js-sdk`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roketus/loyalty-js-sdk",
|
|
3
|
-
"version": "5.4.
|
|
3
|
+
"version": "5.4.1",
|
|
4
4
|
"main": "./dist/cjs/index.js",
|
|
5
5
|
"module": "./dist/esm5/index.js",
|
|
6
6
|
"author": "Skoch <st.ixidor@gmail.com>",
|
|
@@ -16,7 +16,8 @@
|
|
|
16
16
|
},
|
|
17
17
|
"files": [
|
|
18
18
|
"dist",
|
|
19
|
-
"README.md"
|
|
19
|
+
"README.md",
|
|
20
|
+
"README.dev.md"
|
|
20
21
|
],
|
|
21
22
|
"license": "MIT",
|
|
22
23
|
"scripts": {
|