@outtalent-dev/shared 1.1.0 → 1.1.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.
- package/README.md +11 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# @outtalent/shared
|
|
1
|
+
# @outtalent-dev/shared
|
|
2
2
|
|
|
3
3
|
Shared UI components, composables, and utilities for Outtalent Vue 3 applications.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @outtalent/shared
|
|
8
|
+
npm install @outtalent-dev/shared
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
@@ -14,14 +14,14 @@ npm install @outtalent/shared
|
|
|
14
14
|
|
|
15
15
|
```vue
|
|
16
16
|
<script setup>
|
|
17
|
-
import { Button, Dialog, DialogContent, DialogHeader, DialogTitle, Input } from '@outtalent/shared'
|
|
17
|
+
import { Button, Dialog, DialogContent, DialogHeader, DialogTitle, Input } from '@outtalent-dev/shared'
|
|
18
18
|
</script>
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
### Utilities
|
|
22
22
|
|
|
23
23
|
```ts
|
|
24
|
-
import { cn, decodeJWT, createApi } from '@outtalent/shared'
|
|
24
|
+
import { cn, decodeJWT, createApi } from '@outtalent-dev/shared'
|
|
25
25
|
|
|
26
26
|
// Tailwind class merging
|
|
27
27
|
const classes = cn('px-4 py-2', condition && 'bg-primary')
|
|
@@ -42,7 +42,7 @@ const api = createApi({
|
|
|
42
42
|
### Composables
|
|
43
43
|
|
|
44
44
|
```ts
|
|
45
|
-
import { usePrivacy, useToast, useSidebarStateSync } from '@outtalent/shared'
|
|
45
|
+
import { usePrivacy, useToast, useSidebarStateSync } from '@outtalent-dev/shared'
|
|
46
46
|
|
|
47
47
|
const { isBlurred, toggleBlur } = usePrivacy()
|
|
48
48
|
const { toast } = useToast()
|
|
@@ -51,7 +51,7 @@ const { toast } = useToast()
|
|
|
51
51
|
### Types
|
|
52
52
|
|
|
53
53
|
```ts
|
|
54
|
-
import type { User, Credentials, PlatformLink } from '@outtalent/shared'
|
|
54
|
+
import type { User, Credentials, PlatformLink } from '@outtalent-dev/shared'
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
## Development
|
|
@@ -67,11 +67,11 @@ npm run dev # watch mode
|
|
|
67
67
|
Releases are automated via GitHub Actions + semantic-release.
|
|
68
68
|
Commit messages must follow [Conventional Commits](https://www.conventionalcommits.org/):
|
|
69
69
|
|
|
70
|
-
- `fix: ...`
|
|
71
|
-
- `feat: ...`
|
|
72
|
-
- `feat!: ...` or `BREAKING CHANGE:`
|
|
70
|
+
- `fix: ...` -- patch release (1.0.0 -> 1.0.1)
|
|
71
|
+
- `feat: ...` -- minor release (1.0.0 -> 1.1.0)
|
|
72
|
+
- `feat!: ...` or `BREAKING CHANGE:` -- major release (1.0.0 -> 2.0.0)
|
|
73
73
|
|
|
74
74
|
### Setup (one-time)
|
|
75
75
|
|
|
76
|
-
1. Ensure `@outtalent` npm organization exists
|
|
77
|
-
2. Add `NPM_TOKEN` secret to GitHub repo settings
|
|
76
|
+
1. Ensure `@outtalent-dev` npm organization exists on [npmjs.com](https://www.npmjs.com/)
|
|
77
|
+
2. Add `NPM_TOKEN` (Automation type) secret to GitHub repo settings
|