@star-insure/sdk 5.0.13 → 6.0.0

package/README.md

@@ -16,6 +16,35 @@ npm start
 npm run test
 ```
 
+## Making changes to this package locally
+### Updating project dependency
+Update the package.json file in your consuming project to reference the relative path to this package. e.g.
+```
+"@star-insure/sdk": "file:../starinsure-sdk",
+```
+
+### npm link [TODO: Fix this somehow. It doesn't actually work, it breaks Inertia]
+From this package root:
+```
+npm link
+```
+
+From the project you're making changes in (e.g. star-insure/portal):
+```
+npm link @star-insure/sdk
+```
+
+From the project you're making changes in (e.g. star-insure/portal):
+```
+npm uninstall --no-save @star-insure/sdk && npm install
+```
+
+[Optional] You can remove the global symlink created for this package by from this package root.
+However you don't need to do this, as you'll likely be doing this again in future.
+```
+npm uninstall
+```
+
 ## Publishing to NPM
 Suggest that you use [np](https://github.com/sindresorhus/np) for publishing.
 
@@ -53,4 +82,4 @@ import { formatMoney } from '@star-insure/sdk';
 
 formatMoney(1234567.89);
 formatMoney('1234567.89');
-```
+```