Skip to content

Commit 74f3308

Browse files
mfranzkenmerget
andauthored
docs: added missing README file and added&corrected GitHub pages URLs (#956)
* docs: added missing README file * docs: added Angular showcases GitHub pages URL * docs: added React showcases GitHub pages URL * docs: added Vue showcases GitHub Pages URL * chore: wording * docs: corrected those links * docs: corrected those links * docs: corrected URLs * chore: slight optimization * chore: slight optimization * fix: corrected that URL * Update README.md --------- Co-authored-by: Nicolas Merget <[email protected]>
1 parent 970a5da commit 74f3308

File tree

7 files changed

+49
-11
lines changed

7 files changed

+49
-11
lines changed

doc/howto-angular.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,6 @@ There are 3 ways to use Events in Angular:
127127

128128
### Example
129129

130-
[Angular Showcase GitHub](https://github.com/db-ui/elements/-/tree/develop/showcase/angular-showcase)
130+
[Angular Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/angular-showcase)
131131

132-
[Angular Showcase App](https://github.com/db-ui/elements/angular-showcase/index.html)
132+
[Angular Showcase App](https://db-ui.github.io/elements/angular-showcase/)

doc/howto-javascript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ In order to test the installation just add a component to your html, like in the
9090

9191
## Frameworks
9292

93-
See documentation for Angular, React and Vue
93+
See documentation for the JavaScript frameworks that we're further supporting:
9494

9595
- [Angular](https://github.com/db-ui/elements/blob/main/doc/howto-angular.md)
9696
- [React](https://github.com/db-ui/elements/blob/main/doc/howto-react.md)
97-
- [Vue](https://github.com/db-ui/elements/blob/main/doc/howto-vue.md)
97+
- [Vue](https://github.com/db-ui/elements/blob/main/doc/howto-vue.md)

doc/howto-react.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,6 @@ Attaching events to DB UI Elements Web Components in React works mostly like you
6565

6666
### Example
6767

68-
[React Showcase GitHub](https://github.com/db-ui/elements/-/tree/develop/showcase/react-showcase)
68+
[React Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/react-showcase)
6969

70-
[React Showcase App](https://github.com/db-ui/elements/react-showcase/index.html)
70+
[React Showcase App](https://db-ui.github.io/elements/react-showcase/)

doc/howto-vue.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,6 @@ Both Inputs in this example do the same:
9595

9696
### Example
9797

98-
[Vue Showcase GitHub](https://github.com/db-ui/elements/-/tree/develop/showcase/vue-showcase)
98+
[Vue Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/vue-showcase)
9999

100-
[Vue Showcase App](https://github.com/db-ui/elements/vue-showcase/index.html)
100+
[Vue Showcase App](https://db-ui.github.io/elements/vue-showcase/)

showcase/angular-showcase/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
66
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
77

8-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.5.
8+
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.5. We're also [hosting the build on GitHub pages](https://db-ui.github.io/elements/angular-showcase/#/).
99

1010
## Development server
1111

showcase/react-showcase/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
66
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
77

8-
This project is for reference how to use DB UI Elements with vanilla React.
8+
This project is for reference how to use DB UI Elements with vanilla React. We're also [hosting the build on GitHub pages](https://db-ui.github.io/elements/react-showcase/index.html).
99

1010
## Installation
1111

@@ -74,4 +74,4 @@ You must remove or replace any Deutsche Bahn brand and design assets as well as
7474

7575
## License
7676

77-
This project is licensed under [Apache-2.0](LICENSE).
77+
This project is licensed under [Apache-2.0](LICENSE).

showcase/vue-showcase/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# DB-UI Vue Showcase
2+
3+
![Apache 2.0 license badge](https://img.shields.io/badge/License-Apache_2.0-blue.svg)
4+
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
5+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
6+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
7+
8+
This project was generated with [Vite](https://vitejs.dev/). We're also [hosting the build on GitHub pages](hthttps://db-ui.github.io/elements/vue-showcase/index.html#/).
9+
10+
## Development server
11+
12+
Run `vite` or `npm run dev` for a dev server. The app will automatically reload if you change any of the source files.
13+
14+
## Build
15+
16+
Run `npm run build` to build the project.
17+
18+
## Contributions
19+
20+
Contributions are very welcome, please refer to the [contribution guide](https://github.com/db-ui/elements/blob/main/CONTRIBUTING.md).
21+
22+
## Code of conduct
23+
24+
We as members, contributors, and leaders pledge to make participation in our
25+
community a harassment-free experience for everyone – have a look at our [Contributor Covenant Code of Conduct](https://github.com/db-ui/elements/blob/main/CODE-OF-CONDUCT.md).
26+
27+
## Deutsche Bahn brand
28+
29+
As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even when being used with the code that we're provide with this product.
30+
31+
Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UI products free to use and release it under the Apache 2.0 license.
32+
Please have a look at our brand portal at <https://marketingportal.extranet.deutschebahn.com/> for any further questions and whom to contact on any brand issues.
33+
34+
You must remove or replace any Deutsche Bahn brand and design assets as well as protected characteristics and trademarks. We're even also planning to provide a neutral theme that would make it much easier for you to use our product without the trademarks by Deutsche Bahn.
35+
36+
## License
37+
38+
This project is licensed under [Apache-2.0](LICENSE).

0 commit comments

Comments
 (0)