Skip to content

Commit e923e87

Browse files
authored
docs: improve docs with ice cream machine instead of ice machines (#7)
* docs: improve docs with ice cream machine instead of ice machines - Resolve very important distinction of "ice machines" vs "ice cream" machines. - Ensure users are aware of the key infrastructure difference between ice-cream and ice machines. * docs: spelling fixes
1 parent f4d9f48 commit e923e87

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
![GitHub release (latest by date)](https://img.shields.io/github/v/release/circa10a/terraform-provider-mcbroken?style=plastic)
66
[![Buy Me A Coffee](https://img.shields.io/badge/BuyMeACoffee-Donate-ff813f.svg?logo=CoffeeScript&style=plastic)](https://www.buymeacoffee.com/caleblemoine)
77

8-
Base the count of your infrastucture resources on the current number of broken mcdonald's ice machines nationally or by a city of your choosing. Powered by [Mcbroken](https://mcbroken.com/).
8+
Base the count of your infrastructure resources on the current number of broken mcdonald's ice cream machines nationally or by a city of your choosing. Powered by [Mcbroken](https://mcbroken.com/).
99

1010
- [terraform-provider-mcbroken](#terraform-provider-mcbroken)
1111
* [Usage](#usage)
@@ -166,3 +166,13 @@ terraform apply
166166
### Windows
167167

168168
![alt text](https://media.giphy.com/media/4cuyucPeVWbNS/giphy.gif)
169+
170+
171+
## FAQ
172+
173+
### Is this based on ice cream machines or ice machines? What is the difference?
174+
175+
This is based on ice cream machines, not ice machines.
176+
Ice machines produce ice for drinks, while ice cream machines produce frozen milk product based treats.
177+
178+
Please don't use this project to rely on _ice machines_ or your results will be incorrect.

docs/data-sources/cities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ None
2424

2525
## Attribute Reference
2626

27-
* `cities` - List of maps that contains cities and their broken ice machine average
27+
* `cities` - List of maps that contains cities and their broken ice cream machine average
2828
* `broken` - National average of broken ice cream machines

docs/index.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Mcbroken Provider
22

3-
Base the count of your infrastucture resources on the current number of broken mcdonald's ice machines nationally or by a city of your choosing. Powered by [Mcbroken](https://mcbroken.com/).
3+
Base the count of your infrastructure resources on the current number of broken mcdonald's ice cream machines nationally or by a city of your choosing. Powered by [Mcbroken](https://mcbroken.com/).
44

55
## Example Usage
66

@@ -52,3 +52,13 @@ output "user_specified_city_not_found" {
5252
## Argument Reference
5353

5454
* `url` - Mcbroken JSON endpoint
55+
56+
57+
## FAQ
58+
59+
### Is this based on ice cream machines or ice machines? What is the difference?
60+
61+
This is based on ice cream machines, not ice machines.
62+
Ice machines produce ice for drinks, while ice cream machines produce frozen milk product based treats.
63+
64+
Please don't use this project to rely on _ice machines_ or your results will be incorrect.

0 commit comments

Comments
 (0)