From 58e11bd4d899fd9943231b55424a954e6398f7a3 Mon Sep 17 00:00:00 2001 From: Jose Joaquin Merino Date: Thu, 18 Sep 2014 21:18:44 -0700 Subject: [PATCH] Fix capitalisation and specificity of parameters Layout changes: - randLoadIncrement makes references to previous 'load increment', so I put former after the latter. - ( didn't add or remove information, just changed order). Content changes: - Specified that probabilities and percentages range from 0 to 1. I think that the word "Percentage" is misleading since percentages range from 0 to 100, maybe it should be loadMaxProportion --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 48f31eb..31d2076 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,13 @@ With all this internet going around, sometimes you just want to experience the t }); ``` 4. Switch up parameters to change your experience: - * **elements** list of DOM elements to limit comcastification to. - * **boxColor** Hex color for the box placed over images. - * **loadMaxPercent** Max percentage of image to load. - * **loadSpeed** Speed to load your images to their max in ms. - * **randLoadIncrement** Set to true to make load increment random, loadIncrement ignored in this case. - * **loadIncrement** Number of pixels to load each time the loadSpeed timer ticks. - * **randomPause** Probability of skipping a pass each time the loadSpeed timer ticks. + * **elements** : A list of DOM elements to limit comcastification to. + * **boxColor** : The hex color for the box placed over images. + * **loadMaxPercent** : The max percentage of image to load. (0 to 1) + * **loadSpeed** : Time required to load your images to their max in ms. + * **loadIncrement** : Number of pixels to load each time the loadSpeed timer ticks. + * **randLoadIncrement**: Set to true to make load increment random, loadIncrement ignored in this case. + * **randomPause** : Probability of skipping a pass each time the loadSpeed timer ticks. (0 to 1) ## See it in action! See an example on the project's site at: http://theonion.github.io/comcastifyjs/