hds-web 1.28.0 → 1.28.2

Sign up to get free protection for your applications and to get access to all the features.
package/README.md CHANGED
@@ -3,11 +3,12 @@
3
3
  <br>
4
4
 
5
5
  Node version: 18.12.1
6
+ React Version > 18
6
7
 
7
8
  ### Steps:
8
- Step 1: npm install hds-web
9
+ `Step 1: npm install hds-web`
9
10
 
10
- Step2: In tailwind.config.js file have the following preset:
11
+ `Step 2: In tailwind.config.js file have the following preset:`
11
12
 
12
13
 
13
14
 
@@ -23,46 +24,44 @@ Step2: In tailwind.config.js file have the following preset:
23
24
  }
24
25
 
25
26
 
26
- Step3: In you main css file:
27
+ `Step 3: In you main css file:`
27
28
 
28
29
  @import 'hds-web/dist/index.css';
29
30
 
30
31
  </br>
31
32
 
32
-
33
33
  ## Storybook local setup:
34
- <br>
35
- Check node version 18.16.2 and run
34
+ <br> Check node version 18.16.2 and run
36
35
 
37
36
  npm install
38
37
 
39
38
  npm run storybook
40
39
 
41
- open localhost:6006
40
+ open port 6006
42
41
 
43
42
  </br>
44
43
 
45
44
  ## Contribution:
46
- <br>
45
+
47
46
 
48
47
  - Pull the latest storyboook changes
49
48
  - Add your component in the library - `/src/HDS/components` and add the component story - `/src/stories` .
50
49
  - Build library ( locally or pipeline )
51
50
  - Publish package
52
51
 
53
- </br>
52
+ <br>
53
+
54
54
 
55
55
  ## Chromatic release
56
- <br>
57
- Pull the latest changes from main branch in your branch
58
- Merge your branch to release-chromatic
59
- </br>
56
+ Pull the latest changes from main branch in your branch,
57
+ Merge your branch to `release-chromatic`
58
+ <br>
60
59
 
61
60
  ## Publish
62
61
 
63
- <br>
64
62
  The package can be published locally or via the pipeline.
65
-
63
+ <br>
64
+ <br>
66
65
  ### For Local:
67
66
 
68
67
  >Note: The user must be registered as **Hasura**
@@ -70,13 +69,14 @@ The package can be published locally or via the pipeline.
70
69
  #### Run the below set of commands:
71
70
 
72
71
  npm run build-lib
72
+ npm publish
73
73
 
74
- ### Note before publishing:
74
+ #### Note before publishing:
75
75
  >Make sure the build is successful with no error<br>
76
76
  All the components should be exported properly,<br>
77
77
  The branch is updated with the latest changes in main branch <br>
78
78
  The package version is upgraded before publishing<br>
79
79
 
80
- npm publish
80
+
81
81
 
82
82
  </br>