You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-15Lines changed: 14 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
This repository contains a ready-to-use Vue-Components-Library based on [munich.de's MDE5 Patternlab](https://patternlab.muenchen.space/).
6
6
7
-
In it's current state only some components exist. The library will continuely grow as the need for new components grows.
7
+
In its current state only some components exist. The library will continually grow as the need for new components grows.
8
8
9
9
We intend to let this project be a community project in which every developer who needs new components contributes the results of his work into this library.
10
10
@@ -16,11 +16,11 @@ In the near future we plan to
16
16
- Create more components
17
17
- Integrate MDE5 Patternlab npm-Package as soon as it's available
18
18
19
-
See the [open issues](#) for a full list of proposed features (and known issues).
19
+
See the [open issues](https://github.com/it-at-m/muc-patternlab-vue/issues) for a full list of proposed features (and known issues).
20
20
21
21
## Usage
22
22
23
-
Please refer to the [documentation](docs/guide/index.md).
23
+
Please refer to the [usage guide](https://it-at-m.github.io/muc-patternlab-vue/guide/).
24
24
25
25
## Develop
26
26
@@ -33,18 +33,6 @@ npm install
33
33
npm run docs:dev
34
34
```
35
35
36
-
### Release and Publish
37
-
38
-
This project uses [semantic-release](https://github.com/semantic-release/semantic-release)!
39
-
40
-
It follows [Angulars Commit Message Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format). For example:
|`perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.`|~~Major~~ Breaking Release |
47
-
48
36
### Adding a new Component
49
37
50
38
1. Create a new Folder under `./src/components`-Directory
@@ -83,6 +71,17 @@ Don't forget to give the project a star! Thanks again!
83
71
84
72
More about this in the [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) file.
85
73
74
+
### Release and Publish
75
+
76
+
This project uses [semantic-release](https://github.com/semantic-release/semantic-release)!
77
+
78
+
It follows [Angulars Commit Message Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format). For example:
|`perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.`|~~Major~~ Breaking Release |
0 commit comments