Skip to content

Commit c0a1e20

Browse files
committed
docs(readme): fix urls and typos in readme
1 parent e297da9 commit c0a1e20

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

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

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

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).
2020

2121
## Usage
2222

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/).
2424

2525
## Develop
2626

@@ -33,18 +33,6 @@ npm install
3333
npm run docs:dev
3434
```
3535

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:
41-
42-
| Commit message | Release type |
43-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
44-
| `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
45-
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
46-
| `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-
4836
### Adding a new Component
4937

5038
1. Create a new Folder under `./src/components`-Directory
@@ -83,6 +71,17 @@ Don't forget to give the project a star! Thanks again!
8371

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

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

8786
## License
8887

0 commit comments

Comments
 (0)