diff --git a/README.md b/README.md index 711a13b..6554e3a 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This package requires: This package uses: - [vuepress](https://github.com/vuejs/vuepress) - [vuepress-theme-book](https://github.com/cyrilf/vuepress-theme-book) - +- [vuepress-deploy](https://github.com/jenkey2011/vuepress-deploy) ## Usage @@ -40,4 +40,12 @@ Run the tests to ensure everything is working as expected ``` npm test -``` \ No newline at end of file +``` + +## How it works + +This repository utilizes `vuepress-deploy` to automatically deploy the current `master` branch to github pages. + +![repo-architecture](./docs/images/docs/architecture.png) + +A Pullrequest-Review-Workflow is applied to get changes into the `master`. From there on an automatic github workflow script utilizing `vuepress-deploy` is taking over. The vuepress page is built and force-pushed to the `gh-pages` branch, which in turn is then deployed on the github pages infrastructure and bound to the web address [IT4C.dev](https://www.it4c.dev). diff --git a/docs/images/docs/architecture.drawio b/docs/images/docs/architecture.drawio new file mode 100644 index 0000000..2f8f71e --- /dev/null +++ b/docs/images/docs/architecture.drawio @@ -0,0 +1,138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/images/docs/architecture.png b/docs/images/docs/architecture.png new file mode 100644 index 0000000..39a962e Binary files /dev/null and b/docs/images/docs/architecture.png differ