diff --git a/README.md b/README.md new file mode 100644 index 0000000..eca022e --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +# MicroRepository 📚 + +A template that gathers the minimal structure of my repository. + +## 🚀 Features + +- Modern README +- Multipull licenses: `Apache 2.0` and `SUSHI-WARE` + + + + + + + + + + + + + + + + + + + + + + + + + + + +## 🎯 Usage + +A guide to using this repository template: + +1. Click `Use this template` > `Create a new repository` in the top right corner. +2. Clone the created repository, rename README.example.md to README.md, edit it with your preferred editor, and migrate. + +```bash +mv README.example.md README.md + +# For Linux users +sed -i 's;HidemaruOwO/MyRepository;USERNAME/REPONAME;g' README.md + +# For macOS users +sed -i '' 's;HidemaruOwO/MyRepository;USERNAME/REPONAME;g' README.md +``` + +## 🌍 For contributer + +By contributing to this project, you agree to the following terms: + +1. **You grant a license**: You grant the project owner a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to use, modify, distribute, and sublicense your contributions under the **Apache License 2.0**. +2. **You retain ownership**: You still own the copyright of your contribution, but you waive any claims against the project related to your contribution. +3. **No additional patent rights**: You **do not** grant additional patent rights beyond what is covered by Apache 2.0. +4. **Your contributions are original**: You confirm that your contributions do not violate any third-party rights. + +By submitting a pull request, you agree to these terms. + +## 📜 License + +
+ +[![Apache License 2.0](https://img.shields.io/badge/License-Apache%20License%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) + +[![SUSHI-WARE LICENSE](https://img.shields.io/badge/License-SUSHI--WARE%20%F0%9F%8D%A3-blue.svg)](https://github.com/MakeNowJust/sushi-ware) + +
+ +This project is dual-licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) and [SUSHI-WARE LICENSE](https://github.com/MakeNowJust/sushi-ware). + +A reference to the latest license should be used, even if the attached license is outdated of major versions. + +## 🤝 Reference + +- [HidemaruOwO/MicroRepository](https://github.com/HidemaruOwO/MicroRepository)