diff --git a/README.md b/README.md index 7bdf9b82..5318b025 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,23 @@ -## Customize this file after creating the new REPO and remove this lines. -What to adjust: -* Add the your project or repo name direct under the logo. -* Add a short and long desciption. -* Add links for your final repo to report a bug or request a feature. -* Add list of used technologies. -* If you have, add a roadmap or remove this section. -* Fill up the section for set up and documentation. - * Start in this file only with documentation and link to the docs folder. -* Add more project shields. Use [shields.io](https://shields.io/) with style `for-the-badge`. - -## ------- end to remove ------- - - -# repo or project name +# Refarch [![Made with love by it@M][made-with-love-shield]][itm-opensource] -*Add a description from your project here.* +Collection of different reference architecture (Refarch) components developed by it@M. +## Usage -### Built With +The usage of the different components is described in their corresponding README.md -The documentation project is built with technologies we use in our projects: - -* *write here the list of used technologies* - -## Roadmap - -*if you have a ROADMAP for your project add this here* - - -See the [open issues](#) for a full list of proposed features (and known issues). - - -## Set up -*how can i start and fly this project* - -## Documentation -*what insights do you have to tell* - -```mermaid -graph TD; - A-->B; - A-->C; - B-->D; - C-->D; -``` - -use [diagrams](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams). +- [refarch-gateway](./refarch-gateway/README.md) ## Contributing -Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any +contributions you make are **greatly appreciated**. -If you have a suggestion that would make this better, please open an issue with the tag "enhancement", fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +If you have a suggestion that would make this better, please open an issue with the tag "enhancement", fork the repo and +create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! 1. Open an issue with the tag "enhancement" @@ -66,16 +29,16 @@ Don't forget to give the project a star! Thanks again! More about this in the [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) file. - ## License Distributed under the MIT License. See [LICENSE](LICENSE) file for more information. - ## Contact it@M - opensource@muenchen.de + [made-with-love-shield]: https://img.shields.io/badge/made%20with%20%E2%9D%A4%20by-it%40M-yellow?style=for-the-badge + [itm-opensource]: https://opensource.muenchen.de/