@dcodegroup-au/dsg-vue 0.1.39 → 1.0.0-next.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.
Files changed (4) hide show
  1. package/README.md +63 -3
  2. package/dist/dsg-vue.cjs +11 -11
  3. package/dist/dsg-vue.esm.js +2104 -2096
  4. package/package.json +4 -4
package/README.md CHANGED
@@ -32,19 +32,36 @@
32
32
 
33
33
  <br/>
34
34
 
35
- ### NPM Package
35
+ ### NPM Package (Stable — Tailwind CSS v3)
36
36
 
37
- For standard Vue 3 project installations, you can install the `dsg-vue` package using any of the following commands below.
37
+ For standard Vue 3 project installations using **Tailwind CSS v3**, install the stable `latest` version:
38
38
 
39
39
  ```sh
40
40
  pnpm i -D @dcodegroup-au/dsg-vue
41
41
  ```
42
+
43
+ <br/>
44
+
45
+ ### NPM Package (Next — Tailwind CSS v4)
46
+
47
+ To install the upcoming **Tailwind CSS v4** pre-release version, use the `next` tag:
48
+
49
+ ```sh
50
+ pnpm i -D @dcodegroup-au/dsg-vue@next
51
+ ```
52
+
53
+ > **Note:** The `next` version (`1.x.x`) targets Tailwind CSS v4 and includes breaking changes. See `TAILWIND_V4_MIGRATION.md` for details.
54
+
42
55
  <br/>
43
56
 
44
57
  ### GitHub Repository
45
58
 
46
59
  ```sh
60
+ # Stable (Tailwind CSS v3)
47
61
  pnpm i -D https://github.com/DCODE-GROUP/dsg-vue#main
62
+
63
+ # Next (Tailwind CSS v4)
64
+ pnpm i -D https://github.com/DCODE-GROUP/dsg-vue#next
48
65
  ```
49
66
  <br/>
50
67
 
@@ -289,4 +306,47 @@ The `dsg-vue` package is built to match the UntitledUI Figma design system. Each
289
306
 
290
307
  For more information on the base Design System Template check out Figma folder for the designated project or at the following link:
291
308
 
292
- - <a href="https://www.figma.com/design/T06aUcOseXpSG6HzgjrlLP/%E2%9D%96-PREVIEW-%E2%9D%96-Untitled-UI-%E2%80%93-PRO-VARIABLES-(v6.0)">UntitledUI - Pro Version Demo</a>
309
+ - <a href="https://www.figma.com/design/T06aUcOseXpSG6HzgjrlLP/%E2%9D%96-PREVIEW-%E2%9D%96-Untitled-UI-%E2%80%93-PRO-VARIABLES-(v6.0)">UntitledUI - Pro Version Demo</a>
310
+
311
+ <br />
312
+ <hr />
313
+ <br />
314
+
315
+ ## Versioning & NPM Tags
316
+
317
+ The library uses two npm distribution tags corresponding to two active branches:
318
+
319
+ | NPM Tag | Branch | Version Range | Tailwind CSS | Status |
320
+ |---------|--------|--------------|-------------|--------|
321
+ | `latest` | `main` | `0.x.x` | v3 | Stable / Current |
322
+ | `next` | `next` | `1.x.x` | v4 | Pre-release |
323
+
324
+ ### Branching Strategy
325
+
326
+ - **`main`** — Stable releases (`0.x.x`). Published to npm as `latest` tag. Uses Tailwind CSS v3.
327
+ - **`next`** — Pre-release builds (`1.x.x`). Published to npm as `next` tag. Targets Tailwind CSS v4.
328
+ - **`develop`** — Active development branch. PRs merge into `develop`, then into `main` or `next`.
329
+
330
+ ### Install Commands
331
+
332
+ ```sh
333
+ # Install stable (Tailwind v3)
334
+ pnpm i -D @dcodegroup-au/dsg-vue
335
+
336
+ # Install next (Tailwind v4)
337
+ pnpm i -D @dcodegroup-au/dsg-vue@next
338
+ ```
339
+
340
+ ### Publishing
341
+
342
+ Publishing is automated via GitHub Actions:
343
+
344
+ - Push to `main` → publishes with `--tag latest`
345
+ - Push to `next` → publishes with `--tag next`
346
+
347
+ When Tailwind CSS v4 is fully released and the `next` branch is merged to `main`, the version will become `1.x.x` with the `latest` tag, and the `0.x.x` line will be tagged as `legacy`:
348
+
349
+ ```sh
350
+ # Future: install legacy Tailwind v3 version
351
+ pnpm i -D @dcodegroup-au/dsg-vue@legacy
352
+ ```