Skip to content

Commit d6b9579

Browse files
authored
chore: Update README.md
1 parent cfba800 commit d6b9579

File tree

1 file changed

+60
-1
lines changed

1 file changed

+60
-1
lines changed

README.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,62 @@
11
# Crunchloop Terraform Provider
22

3-
TODO
3+
[![License](https://img.shields.io/badge/license-MPL--2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
4+
5+
The Crunchloop Terraform Provider enables you to manage your Crunchloop resources using Terraform.
6+
7+
## Requirements
8+
9+
- [Terraform](https://www.terraform.io/downloads.html) 1.0+
10+
- [Go](https://golang.org/doc/install) 1.16+
11+
12+
## Installation
13+
14+
To install the provider, copy and paste the code below into your Terraform configuration. Then, run `terraform init` to initialize the provider.
15+
16+
```hcl
17+
terraform {
18+
required_providers {
19+
crunchloop = {
20+
source = "crunchloop/crunchloop"
21+
version = "0.1.0"
22+
}
23+
}
24+
}
25+
26+
provider "crunchloop" {
27+
url = "http://localhost:3000"
28+
}
29+
```
30+
31+
## Usage
32+
33+
Here is an example of how to use the provider to manage a Crunchloop resource:
34+
35+
```hcl
36+
data "crunchloop_vmi" "ubuntu" {
37+
name = "ubuntu-jammy-server-amd64-20241002"
38+
}
39+
40+
resource "crunchloop_vm" "vm" {
41+
name = "terraform-test"
42+
vmi_id = data.crunchloop_vmi.ubuntu.id
43+
cores = 1
44+
memory_megabytes = 1024
45+
root_volume_size_gigabytes = 10
46+
}
47+
```
48+
49+
## Developing the Provider
50+
51+
If you wish to contribute to the provider, follow these steps:
52+
53+
1. Clone the repository
54+
2. Build the provider using Go: `go build ./...`
55+
56+
## Documentation
57+
58+
- [Terraform Documentation](https://registry.terraform.io/providers/crunchloop/crunchloop/latest/docs)
59+
60+
## License
61+
62+
This project is licensed under the Mozilla Public License 2.0.

0 commit comments

Comments
 (0)