Skip to content

Commit 6e53382

Browse files
committed
feat(docs): update docs with usage-info
1 parent 6991a7b commit 6e53382

File tree

2 files changed

+45
-10
lines changed

2 files changed

+45
-10
lines changed

README.md

Lines changed: 43 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,6 @@ In it's current state only some components exist. The library will continuely gr
88

99
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.
1010

11-
### Built With
12-
13-
The documentation project is built with technologies we use in our projects:
14-
15-
* Vue 3
16-
* [MDE5 Patternlab](https://patternlab.muenchen.space/)
17-
1811
## Roadmap
1912

2013
In the near future we plan to
@@ -25,7 +18,37 @@ In the near future we plan to
2518

2619
See the [open issues](#) for a full list of proposed features (and known issues).
2720

28-
## Set up
21+
## Usage
22+
23+
### Installation
24+
25+
```shell
26+
npm i @muenchen/muc-patternlab-vue
27+
```
28+
29+
Required Peer Dependencies:
30+
31+
```
32+
"vue": "^3.4.0"
33+
```
34+
35+
### Use
36+
37+
e.G. Using the MucBanner-Component:
38+
39+
```vue
40+
<script setup>
41+
import { MucBanner } from "@muenchen/muc-patternlab-vue";
42+
</script>
43+
44+
<template>
45+
<muc-banner title="Hello Muc">
46+
<div>How are you?</div>
47+
</muc-banner>
48+
</template>
49+
```
50+
51+
## Develop
2952

3053
```shell
3154
git clone https://github.com/it-at-m/muc-patternlab-vue.git
@@ -36,6 +59,18 @@ npm run dev
3659

3760
## Documentation
3861

62+
### Release and Publish
63+
64+
This project uses [semantic-release](https://github.com/semantic-release/semantic-release)!
65+
66+
It follows [Angulars Commit Message Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format). For example:
67+
68+
| Commit message | Release type |
69+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
70+
| `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
71+
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
72+
| `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 |
73+
3974
### Adding a new Component
4075

4176
1. Create a new Folder under `./src/components`-Directory

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
"format": "prettier --write src/",
3333
"semantic-release": "semantic-release"
3434
},
35-
"dependencies": {
36-
"vue": "^3.4.15"
35+
"peerDependencies": {
36+
"vue": "^3.4.0"
3737
},
3838
"devDependencies": {
3939
"@rushstack/eslint-patch": "^1.3.3",

0 commit comments

Comments
 (0)