@wra-gov/vue-components 0.2.0 → 0.3.0

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 CHANGED
@@ -1,17 +1,23 @@
1
-
2
1
  # Welsh Revenue Authority Component Library
3
2
 
4
- ![NPM Version](https://img.shields.io/npm/v/%40wra-gov%2Fvue-components)
5
-
6
3
  Vue component library created by Welsh Revenue Authority
7
4
 
5
+ [![NPM Version](https://img.shields.io/npm/v/%40wra-gov%2Fvue-components)](https://www.npmjs.com/package/@wra-gov/vue-components)
6
+
8
7
  ## Installation
9
8
 
10
- **TODO**
9
+ Dependencies:
10
+
11
+ - Vue 3
12
+ - maska
13
+
14
+ Install,
15
+
16
+ `npm install @wra/vue-components`
11
17
 
12
18
  ## Usage
13
19
 
14
- > Default import
20
+ ### Default import
15
21
 
16
22
  `main.js`,
17
23
 
@@ -28,31 +34,31 @@ app.use(Wra);
28
34
  app.mount("#app");
29
35
  ```
30
36
 
31
- > Named imports
37
+ ### Named imports
32
38
 
33
- Composition:
39
+ Composition API:
34
40
 
35
41
  `*.vue`,
36
42
 
37
43
  ```html
38
44
  <script>
39
- import WraButton from "@wra-gov/vue-components";
45
+ import WraButton from "@wra-gov/vue-components";
40
46
 
41
- export default {
42
- components: {
43
- WraButton,
44
- },
45
- };
47
+ export default {
48
+ components: {
49
+ WraButton,
50
+ },
51
+ };
46
52
  </script>
47
53
  ```
48
54
 
49
- Options:
55
+ Options API:
50
56
 
51
57
  `*.vue`,
52
58
 
53
59
  ```html
54
60
  <script setup>
55
- import { Button } from "@wra-gov/vue-components";
61
+ import { Button } from "@wra-gov/vue-components";
56
62
  </script>
57
63
 
58
64
  ...
@@ -62,6 +68,6 @@ import { Button } from "@wra-gov/vue-components";
62
68
 
63
69
  [Storybook documentation](https://welsh-revenue-authority.github.io/component-library)
64
70
 
65
- ## License and Copyright
71
+ ## Licence and Copyright
66
72
 
67
73
  WRA component library is available under [Open Government 3.0 licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)