update readme-publish

VCG · Mar 10, 2023 · 9ff39db · 9ff39db
1 parent ef05607
commit 9ff39db
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -23,4 +23,6 @@ yarn-debug.log*
 yarn-error.log*
 
 /.idea
-/dist
+/dist
+
+*.tgz
diff --git a/README-Publish.md b/README-Publish.md
@@ -51,13 +51,24 @@ Add some fields that could be a metadata for the package with the following:
 ```
 
 ### Test the package
+#### In the *vimo-sketches* Project
 Build the package 
 
 `npm run build`
 
-To test the package locally, you need to create a new React project and link the package to the new project.
+Pack the package
 
-`npm link ../vimo-sketches/node_modules/react`
+`npm pack`
+
+This will create `.tgz` file in your project's root path.
+
+
+#### In the *test* Project
+To test the package locally, you need to create a new React project. Please install the *vimo-sketches* package to your test project.
+
+`npm install ../vimo-sketches/vimo-public-vimo-sketches-{VERSION}.tgz`
+
+> You need to change the *vimo-sketches* package version number for the package update to take effect in your *test* project. 
 
 ### Publish
 Login to the npm repository
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,4 +23,6 @@ yarn-debug.log* @@
     yarn-error.log*
     /.idea
-    /dist
+    /dist
+    *.tgz