@muonic/muon 0.0.2-experimental-156-ab51545.0 → 0.0.2-experimental-157-888b272.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 +38 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Muon
|
|
2
|
+
|
|
3
|
+
> ⚠️ Experimental. Use at your own risk. Things might change and break.
|
|
4
|
+
|
|
5
|
+
Muon is a versatile token based pattern library using webcomponents for Design Systems. It provides a foundation for building a Design System and a set of components to get you started. Unlike other pattern libraries we don't provide a set of styles, we provide a set of tokens that can be used to build your own styles.
|
|
6
|
+
|
|
7
|
+
This means you can quickly get your own branded components up and running without having to write any CSS or JavaScript.
|
|
8
|
+
|
|
9
|
+
## Useful links
|
|
10
|
+
|
|
11
|
+
- [Component documentation](https://centrica-engineering.github.io/muon/)
|
|
12
|
+
- [Storybook](https://main--61dd6b0ee46d9a004ac27873.chromatic.com/)
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install --save @muonic/muon
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Create a new project
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm init muon
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Changelog
|
|
27
|
+
|
|
28
|
+
See [CHANGELOG.md](CHANGELOG.md)
|
|
29
|
+
|
|
30
|
+
## Design tokens and themes
|
|
31
|
+
|
|
32
|
+
Muon uses design tokens to provide a consistent look and feel across all components. Tokens are defined in a JSON file and can be used to build your own styles. Muon provides a default theme that can be used as a starting point for your own theme.
|
|
33
|
+
|
|
34
|
+
[MORE TO EXPLAIN HERE]
|
|
35
|
+
|
|
36
|
+
## Creating a new component
|
|
37
|
+
|
|
38
|
+
[MORE TO EXPLAIN HERE]
|