Skip to content

Commit

Permalink
chore: add new readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
Nacho Anaya authored Jul 17, 2021
1 parent 7ac441a commit 02a3f75
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
<img width="400px" src="./docs/images/terraform.png" alt="Terraform" />
</p>

# Checkly Terraform Provider
<p>
<img height="128" src="https://www.checklyhq.com/images/footer-logo.svg" align="right" />
<h1>Checkly Terraform Provider</h1>
</p>

[![Tests](https://github.com/checkly/terraform-provider-checkly/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/checkly/terraform-provider-checkly/actions/workflows/test.yml)
[![Release](https://github.com/checkly/terraform-provider-checkly/actions/workflows/release.yml/badge.svg)](https://github.com/checkly/terraform-provider-checkly/actions/workflows/release.yml)
Expand All @@ -19,15 +22,15 @@ This Terraform provider enables users to manage [Checkly](https://checklyhq.com)

<br>

## 🪛 Install the provider
## 🪛 Installation

Please refer to the [installation guide](https://github.com/checkly/terraform-provider-checkly/blob/master/docs/guides/getting-started.md)

If you're still using Terraform 0.12 please refer to [terraform 0.12 documentation](https://github.com/checkly/terraform-provider-checkly/blob/master/docs/guides/support-for-terraform-0.12.md)

<br>

## 🏗 Use the provider
## 🔧 How to use?

For documentation and example usage see:
1. [Checkly's documentation](https://www.checklyhq.com/docs/integrations/terraform/).
Expand All @@ -41,7 +44,7 @@ You can also find step-by-step guides on Checkly's blog:

<br>

## 🧑‍💻 Develop the provider
## 🖥️ Run Locally

Clone the repo, build the project and add it to your Terraform plugins directory. You will need to have Go installed.

Expand All @@ -58,11 +61,15 @@ go build && CHECKLY_API_KEY=XXX go test -tags=integration

[MIT](https://github.com/checkly/terraform-checkly-provider/blob/master/LICENSE)

<h3 align="center">Supported by</h3>
<br>


<p align="center">
<a href="https://checklyhq.com?utm_source=github&utm_medium=sponsor-logo-github&utm_campaign=headless-recorder" target="_blank">
<img width="200px" src="./docs/images/checkly.png" alt="Checkly" />
<img width="100px" src="https://www.checklyhq.com/images/text_racoon_logo.svg" alt="Checkly" />
</a>
<br />
<i><sub>Delightful Active Monitoring for Developers</sub></i>
<br>
<b><sub>From Checkly with ♥️</sub></b>
<p>

0 comments on commit 02a3f75

Please sign in to comment.