Merge pull request #7 from tatsutakein/rt/improve-readme

docs: README を更新

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 @tatsutakein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,15 +1,56 @@
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![renovate](https://img.shields.io/badge/maintaied%20with-renovate-blue?logo=renovatebot)](https://app.renovatebot.com/dashboard)
+![GitHub last commit (branch)](https://img.shields.io/github/last-commit/tatsutakein/project-boilerplate)
+
 # Project boilerplate
 
-プロジェクト作成時のテンプレートです.
+Template for project creation.
+
+## Features
+
+TBD
 
-## GetStarted
+### Screenshots
 
-以下の手順を踏んで開発に参加しましょう.
+TBD
 
-### 1. Bootstrap
+## Get Started
 
-以下のコマンドを実行して開発環境を整えます.
+After git clone, run the following command
 
 ```shell
 $ make bs
 ```
+
+## Development Environment
+
+TBD
+
+## Architecture
+
+TBD
+
+## Build
+
+TBD
+
+## Testing
+
+TBD
+
+## Performance
+
+TBD
+
+## Contributors
+
+Thanks to our wonderful contributors!
+
+<a href="https://github.com/tatsutakein/project-boilerplate/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=tatsutakein/project-boilerplate" />
+</a>
+
+## License
+
+boilerplate is distributed under the terms of the MIT License. See the [license](LICENSE) for more
+information.