Skip to content

Commit

Permalink
feat(docs): update docs with usage-info
Browse files Browse the repository at this point in the history
  • Loading branch information
FabianWilms committed Apr 5, 2024
1 parent 6991a7b commit 6e53382
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 10 deletions.
51 changes: 43 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,6 @@ In it's current state only some components exist. The library will continuely gr

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.

### Built With

The documentation project is built with technologies we use in our projects:

* Vue 3
* [MDE5 Patternlab](https://patternlab.muenchen.space/)

## Roadmap

In the near future we plan to
Expand All @@ -25,7 +18,37 @@ In the near future we plan to

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

## Set up
## Usage

### Installation

```shell
npm i @muenchen/muc-patternlab-vue
```

Required Peer Dependencies:

```
"vue": "^3.4.0"
```

### Use

e.G. Using the MucBanner-Component:

```vue
<script setup>
import { MucBanner } from "@muenchen/muc-patternlab-vue";
</script>
<template>
<muc-banner title="Hello Muc">
<div>How are you?</div>
</muc-banner>
</template>
```

## Develop

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

## Documentation

### Release and Publish

This project uses [semantic-release](https://github.com/semantic-release/semantic-release)!

It follows [Angulars Commit Message Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format). For example:

| Commit message | Release type |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
| `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
| `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 |

### Adding a new Component

1. Create a new Folder under `./src/components`-Directory
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
"format": "prettier --write src/",
"semantic-release": "semantic-release"
},
"dependencies": {
"vue": "^3.4.15"
"peerDependencies": {
"vue": "^3.4.0"
},
"devDependencies": {
"@rushstack/eslint-patch": "^1.3.3",
Expand Down

0 comments on commit 6e53382

Please sign in to comment.