Skip to content

Commit 77cb531

Browse files
Update README.md and docs (#72)
Co-authored-by: mcalhoun <[email protected]>
1 parent c95e9af commit 77cb531

File tree

1 file changed

+11
-52
lines changed

1 file changed

+11
-52
lines changed

README.md

Lines changed: 11 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
2+
13
<!-- markdownlint-disable -->
24
# github-action-setup-atmos <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
35
<a href="https://github.com/cloudposse/github-action-setup-atmos/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-setup-atmos.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
@@ -27,16 +29,6 @@
2729
Install atmos for use in GitHub Actions
2830

2931

30-
---
31-
> [!NOTE]
32-
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content=) approach towards DevOps.
33-
> <details><summary><strong>Learn More</strong></summary>
34-
>
35-
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
36-
>
37-
> </details>
38-
39-
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
4032

4133

4234
## Introduction
@@ -48,9 +40,8 @@ command and make them available to subsequent steps via outputs of the same name
4840

4941

5042

51-
## Usage
52-
5343

44+
## Usage
5445

5546
```yaml
5647
steps:
@@ -143,23 +134,21 @@ For additional context, refer to some of these links.
143134
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
144135

145136

137+
138+
146139
## ✨ Contributing
147140

148141
This project is under active development, and we encourage contributions from our community.
142+
143+
144+
149145
Many thanks to our outstanding contributors:
150146

151147
<a href="https://github.com/cloudposse/github-action-setup-atmos/graphs/contributors">
152148
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-setup-atmos&max=24" />
153149
</a>
154150

155-
### 🐛 Bug Reports & Feature Requests
156-
157-
Please use the [issue tracker](https://github.com/cloudposse/github-action-setup-atmos/issues) to report any bugs or file feature requests.
158-
159-
### 💻 Developing
160-
161-
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
162-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content=slack), in the `#cloudposse` channel.
151+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-setup-atmos/issues).
163152

164153
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
165154
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-setup-atmos/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
@@ -184,38 +173,6 @@ Dropped straight into your Inbox every week — and usually a 5-minute read.
184173

185174
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
186175
It's **FREE** for everyone!
187-
188-
## About
189-
190-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content=">Cloud Posse, LLC</a>.
191-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
192-
193-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content=commercial_support) for funded startups and enterprises.
194-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
195-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
196-
197-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
198-
199-
*Your team can operate like a pro today.*
200-
201-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
202-
203-
<details>
204-
<summary>📚 <strong>See What's Included</strong></summary>
205-
206-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
207-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
208-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
209-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
210-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
211-
- **Training.** You'll receive hands-on training so your team can operate what we build.
212-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
213-
- **Troubleshooting.** You'll get help to triage when things aren't working.
214-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
215-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
216-
</details>
217-
218-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-setup-atmos&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
219176
## License
220177

221178
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
@@ -250,6 +207,8 @@ under the License.
250207
## Trademarks
251208

252209
All other trademarks referenced herein are the property of their respective owners.
210+
211+
253212
---
254213
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
255214

0 commit comments

Comments
 (0)