@momentum-design/components 0.0.18 → 0.0.20

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 (2) hide show
  1. package/README.md +4 -31
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,39 +1,12 @@
1
1
  # @momentum-design/components
2
2
 
3
- [![license: mit](https://img.shields.io/badge/License-MIT-blueviolet?style=flat-square)](https://github.com/momentum-design/momentum-design/blob/main/LICENSE)
4
- ![State](https://img.shields.io/badge/State-Alpha-blue?style=flat-square)
3
+ [![license: mit](https://img.shields.io/badge/License-MIT-blueviolet?style=flat-square)](https://github.com/momentum-design/momentum-design/blob/main/LICENSE) ![State](https://img.shields.io/badge/State-Alpha-blue?style=flat-square) [![NPM Version](https://img.shields.io/npm/v/%40momentum-design%2Fcomponents)](https://www.npmjs.com/package/@momentum-design/components)
5
4
 
6
5
  ## Overview
7
6
 
8
- This package is Work In Progress - there is no guarantee for consistency, stability till properly released.
7
+ This package is **Work In Progress** - there is no guarantee for consistency, stability till properly released.
9
8
  There will be breaking changes coming up - it is not recommended to consume this package in this early stage.
10
9
 
11
- ## Steps to run this package
10
+ ## Consumption
12
11
 
13
- - Follow the steps mentioned in the [first time setup](https://github.com/momentum-design/momentum-design/blob/main/CONTRIBUTING.md#first-time-setup).
14
- - Build all dependencies to run components package
15
- ```
16
- yarn telemetry build
17
- yarn token-builder build
18
- yarn tokens build
19
- yarn common build
20
- yarn builder build
21
- yarn fonts build
22
- yarn icons build
23
- ```
24
- - Run this to start storybook and develop components
25
- ```
26
- yarn components dev
27
- ```
28
-
29
- ## Contributing
30
-
31
- See [our contributing guide](./CONTRIBUTING.md)
32
-
33
- ## Scripts
34
-
35
- See [our script documentation](./SCRIPTS.md)
36
-
37
- ## Testing
38
-
39
- See [our testing documentation](./TESTING.md)
12
+ To be provided once available.
package/package.json CHANGED
@@ -28,5 +28,5 @@
28
28
  "@momentum-design/icons": "*",
29
29
  "@momentum-design/tokens": "*"
30
30
  },
31
- "version": "0.0.18"
31
+ "version": "0.0.20"
32
32
  }