From 21c5fb51ed884f77b8b7a132c611dbfd8728f316 Mon Sep 17 00:00:00 2001 From: CHIKAMATSU Naohiro Date: Sun, 24 Dec 2023 01:06:27 +0900 Subject: [PATCH] Update documents --- CHANGELOG.md | 3 ++- README.md | 17 ++++++++++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 37832f0..bcfa6bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1,3 @@ -## [](/compare/77bdf974281a...) (2023-12-23) +## [](https://github.com/nao1215/rainbow/compare/77bdf974281a...) (2023-12-24) +* Introduce project template files [#1](https://github.com/nao1215/rainbow/pull/1) ([nao1215](https://github.com/nao1215)) diff --git a/README.md b/README.md index 9063bc5..13dbad3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,26 @@ [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +![Coverage](https://raw.githubusercontent.com/nao1215/octocovs-central-repo/main/badges/nao1215/rainbow/coverage.svg) +[![LinuxUnitTest](https://github.com/nao1215/rainbow/actions/workflows/linux_test.yml/badge.svg)](https://github.com/nao1215/rainbow/actions/workflows/linux_test.yml) +[![WindowsUnitTest](https://github.com/nao1215/rainbow/actions/workflows/windows_test.yml/badge.svg)](https://github.com/nao1215/rainbow/actions/workflows/windows_test.yml) +[![MacUnitTest](https://github.com/nao1215/rainbow/actions/workflows/mac_test.yml/badge.svg)](https://github.com/nao1215/rainbow/actions/workflows/mac_test.yml) +[![reviewdog](https://github.com/nao1215/rainbow/actions/workflows/reviewdog.yml/badge.svg)](https://github.com/nao1215/rainbow/actions/workflows/reviewdog.yml) +[![Gosec](https://github.com/nao1215/rainbow/actions/workflows/security.yml/badge.svg)](https://github.com/nao1215/rainbow/actions/workflows/security.yml) +[![Go Report Card](https://goreportcard.com/badge/github.com/nao1215/rainbow)](https://goreportcard.com/report/github.com/nao1215/rainbow) + ## rainbow > [!IMPORTANT] > This project is under development. Do not use it in production environments. The rainbow project is a toolset for managing AWS resources. This project consists of multiple CLI and CloudFormation templates. +## Supported OS & Go version +- Linux +- Mac +- Windows +- Go 1.19 or later + ## CLI List [WIP] @@ -20,7 +34,8 @@ This project is licensed under the terms of the MIT license. See the [LICENSE](. Contributions are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md), [Code of Conduct](./CODE_OF_CONDUCT.md) for more information. This project incurs costs on AWS, and financial support from you would make it easier to maintain the project. If you wish to provide financial support, please do so through [GitHub Sponsors](https://github.com/sponsors/nao1215) ## GitHub Star History -[WIP] +Stars from you motivate me to keep going. +[![Star History Chart](https://api.star-history.com/svg?repos=nao1215/rainbow&type=Date)](https://star-history.com/#nao1215/rainbow&Date) ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):