Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
nao1215 committed Dec 23, 2023
1 parent b939122 commit 21c5fb5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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))
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
![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]

Expand All @@ -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)):
Expand Down

0 comments on commit 21c5fb5

Please sign in to comment.