Skip to content

Commit

Permalink
docs(readme): fix urls and typos in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@FabianWilms
FabianWilms committed Apr 9, 2024
1 parent e297da9 commit c0a1e20
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This repository contains a ready-to-use Vue-Components-Library based on [munich.de's MDE5 Patternlab](https://patternlab.muenchen.space/).

In it's current state only some components exist. The library will continuely grow as the need for new components grows.
In its current state only some components exist. The library will continually grow as the need for new components grows.

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.

Expand All @@ -16,11 +16,11 @@ In the near future we plan to
- Create more components
- Integrate MDE5 Patternlab npm-Package as soon as it's available

See the [open issues](#) for a full list of proposed features (and known issues).
See the [open issues](https://github.com/it-at-m/muc-patternlab-vue/issues) for a full list of proposed features (and known issues).

## Usage

Please refer to the [documentation](docs/guide/index.md).
Please refer to the [usage guide](https://it-at-m.github.io/muc-patternlab-vue/guide/).

## Develop

Expand All @@ -33,18 +33,6 @@ npm install
npm run docs:dev
```

### 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 Expand Up @@ -83,6 +71,17 @@ Don't forget to give the project a star! Thanks again!

More about this in the [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) file.

### 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 |

## License

Expand Down

0 comments on commit c0a1e20

Please sign in to comment.