@everchron/ec-shards 8.0.3 → 8.0.5

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 (8) hide show
  1. package/README.md +14 -43
  2. package/dist/ec-shards.js +1413 -1295
  3. package/dist/ec-shards.umd.cjs +1 -1
  4. package/dist/star-active-db51aee0.js +25 -0
  5. package/dist/star-bd3d107d.js +24 -0
  6. package/dist/style.css +1 -1
  7. package/package.json +10 -10
  8. package/dist/star-6209ac66.js +0 -24
package/README.md CHANGED
@@ -22,40 +22,14 @@ Expected node version: >= 18.*
22
22
 
23
23
  ### Project setup
24
24
 
25
- Run the commad below to install the dependencies:
26
-
27
- ```
28
- npm install
29
- ```
30
-
31
- Compiles and hot-reloads for app development:
32
- ```
33
- npm run dev
34
- ```
35
-
36
- Compiles, minifies, and builds package
37
-
38
- ```
39
- npm run build
40
- ```
41
-
42
- Run Unit Tests with [Vitest](https://vitest.dev/)
43
-
44
- ```
45
- npm run test:unit
46
- ```
47
-
48
- Publishes built package to npm (main branch)
49
-
50
- ```
51
- npm publish --access public
52
- ```
53
-
54
- Published built package to npm with a feature/branch tag
55
-
56
- ```
57
- npm publish --access public --tag beta
58
- ```
25
+ | Command | Description |
26
+ | --- | --- |
27
+ | `npm install` | Install the dependencies |
28
+ | `npm run dev` | Compiles and hot-reloads for app development |
29
+ | `npm run build` | Compiles, minifies, and builds package |
30
+ | `npm run test:unit` | Run Unit Tests with [Vitest](https://vitest.dev/) |
31
+ | `npm publish --access public` | Publishes built package to npm (main branch). **Note:** You must be logged into npm with an account that has access to the @everchron organization. Additionally, you need to bump the version number in `package.json` before publishing. |
32
+ | `npm publish --access public --tag beta` | Published built package to npm with a feature/branch tag |
59
33
 
60
34
  ## Recommended IDE Setup
61
35
 
@@ -67,17 +41,14 @@ See [Vite Configuration Reference](https://vitejs.dev/config/).
67
41
 
68
42
 
69
43
  ### Storybook
70
- [Storybook](https://storybook.js.org/) provides a sandbox to build UI components in isolation. You can view Storybook hosted on Github pages [here](https://everchron.github.io/ec-shards/). To compile stories and run Storybook locally, run:
71
-
72
- ```
73
- npm run storybook
74
- ```
44
+ [Storybook](https://storybook.js.org/) provides a sandbox to build UI components in isolation. You can view Storybook hosted on Github pages [here](https://everchron.github.io/ec-shards/).
75
45
 
76
- To view Storybook visit `http://localhost:6006/` in your browser. To build a static version of Storybook, that is hosted on Github pages, run:
46
+ To view Storybook visit http://localhost:6006/ in your browser.
77
47
 
78
- ```
79
- npm run build-storybook
80
- ```
48
+ | Command | Description |
49
+ | --- | --- |
50
+ | `npm run storybook` | Compile stories and run Storybook locally |
51
+ | `npm run build-storybook` | Build a static version of Storybook, hosted on Github pages |
81
52
 
82
53
  ## Design Tokens
83
54