Skip to content

Commit 915486a

Browse files
committed
Add argument documentation for the registry
1 parent 97658fb commit 915486a

File tree

4 files changed

+25
-4
lines changed

4 files changed

+25
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ terraform {
77
required_providers {
88
diceroll = {
99
source = "briancain/diceroll"
10-
version = ">=0.1.3"
10+
version = ">=0.1.4"
1111
}
1212
}
1313
}

docs/index.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
# terraform-provider-diceroll
22

3-
This provider is still a work in progress. These docs will be updated once it is functional.
3+
A terraform provider to roll x number of y sided die :game_die:
4+
5+
## Argument Reference
6+
7+
* `description` - (Optional) This field can be used to give a short description
8+
of the die used in your resource.
9+
* `seed` - (Required) This string is used to seed the random number generator
10+
used to roll the die.
11+
* `sides` - (Required, defaults to 1) Can be used to define how many sides
12+
your die will have. There is no real upper limit to this number beyond what
13+
Terraform supports as a `TypeInt`.
14+
* `quantity` - (Optional, defaults to 1) The number of die to roll together
15+
in the resource.
16+
17+
### Computed Arguments
18+
19+
The following values are automatically computed by Terraform given the arguments
20+
above defined in a resource.
21+
22+
* `computed_total` (int) This field is the sum of all die rolled for a given resource
23+
* `result` (Array of Ints) This field contains the resulting roll for each die
24+
defined inside the resource.
425

526
## Usage
627

example/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ terraform {
22
required_providers {
33
diceroll = {
44
source = "briancain/diceroll"
5-
version = ">=0.1.3"
5+
version = ">=0.1.4"
66
}
77
}
88
}

version.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.1.3
1+
0.1.4

0 commit comments

Comments
 (0)