@citruslime/ui 5.0.0-beta.7 → 5.0.0-beta.8

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.
Files changed (6) hide show
  1. package/README.md +13 -1
  2. package/dist/citrus-lime-ui.js +1 -1
  3. package/dist/components/input-v2/input-number/cl-ui-input-number.vue.d.ts +2 -0
  4. package/dist/components/input-v2/input-text/cl-ui-input-text.vue.d.ts +2 -0
  5. package/dist/components/select/cl-ui-select.vue.d.ts +1 -0
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -9,7 +9,7 @@ A Vue 3 custom component library, used by Citrus-Lime management applications.
9
9
  - 📖 [Documentation & API](https://uilibrary.citruslime.com)
10
10
  - 📌 [Citrus-Lime Ltd](https://www.citruslime.com)
11
11
 
12
- ### Install
12
+ ## Install
13
13
 
14
14
  `pnpm add @citruslime/ui`
15
15
 
@@ -20,3 +20,15 @@ or
20
20
  or
21
21
 
22
22
  `npm install @citruslime/ui`
23
+
24
+ ## Development
25
+
26
+ ### Linking to a project
27
+
28
+ For testing in development, you can use the `link` command to see the effects of UI Library changes within another project.
29
+
30
+ 1. Open up the external project and run `pnpm link [path]` (using whatever package manager this external project is configured with), supplying it with the absolute path to the correct package within your local UI Library repo. E.g. `<root>/packages/ui`.
31
+ - You can run the `link` command multiple times to link multiple UI Library packages at once
32
+ 2. Build the relevant packages in the UI Library with `pnpm build`
33
+ 3. Run the external project - the changes within the UI Library repo should now be visible
34
+ 4. When you make additional changes to the UI Library code, rebuild the relevent packages - the external project UI should then pick up the new changes when reloaded