Merge pull request #1012 from M-DEV-1/M-DEV-1/add-sistent-instructions

Add Instructions for how to refer to your local Sistent fork

Author: amitamrutiya

README.md

@@ -71,12 +71,55 @@ To run tests:
 make tests
 ```
 
-To attach sistent to your project use:
+#### Using your local Sistent Fork in a Project
+
+1. Install your local Sistent package in the project
 
 ```
 npm install <path-to-sistent-on-local-machine>
 ```
 
+> Example:
+>
+> ```
+> # relative path
+> npm install ../../sistent
+>
+> # absolute path
+> npm install /home/five/code/sistent
+> ```
+
+This will update your Sistent dependency to:
+
+```
+"@layer5/sistent" : "file:../../sistent"
+```
+
+2. Build your local Sistent fork
+
+After making changes to your fork, run this command in your local Sistent package.
+
+```
+make build
+```
+
+3. Run the build command in the project where your local Sistent fork is installed.
+
+```
+# example, Meshery UI
+make ui-build
+```
+
+Now your project should reflect changes from your local Sistent fork.
+
+If you want to remove the local Sistent fork from your project, run:
+
+```
+npm uninstall @layer5/sistent
+```
+
+This will remove the local Sistent package from your project. You will have to install the standard package again after running this command.
+
 > [!NOTE]
 > Avoid using `type any` in your code. Always specify explicit types to ensure type safety and maintainability.