Skip to content

Commit 035062d

Browse files
authored
Update README.md
1 parent 3002170 commit 035062d

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

+18-11
Original file line numberDiff line numberDiff line change
@@ -208,17 +208,24 @@ Example
208208

209209
Here is the string `Lives down BY the River` with each of the converters:
210210

211-
(noCase) // Lives down BY the River
212-
(camelCase) // livesDownByTheRiver
213-
(constantCase) // LIVES_DOWN_BY_THE_RIVER
214-
(dotCase) // lives.down.by.the.river
215-
(kebabCase) // lives-down-by-the-river
216-
(lowerCase) // livesdownbytheriver
217-
(pascalCase) // LivesDownByTheRiver
218-
(pathCase) // lives/down/by/the/river
219-
(sentenceCase) // Lives down by the river
220-
(snakeCase) // lives_down_by_the_river
221-
(titleCase) // Lives Down By The River
211+
// If you typed in 'Lives down BY the River' for the __replacerSlot__ and
212+
// used one of the optional Case Converters you would get the following:
213+
214+
__replacerSlot__(noCase) // Lives down BY the River
215+
__replacerSlot__(camelCase) // livesDownByTheRiver
216+
__replacerSlot__(constantCase) // LIVES_DOWN_BY_THE_RIVER
217+
__replacerSlot__(dotCase) // lives.down.by.the.river
218+
__replacerSlot__(kebabCase) // lives-down-by-the-river
219+
__replacerSlot__(lowerCase) // livesdownbytheriver
220+
__replacerSlot__(pascalCase) // LivesDownByTheRiver
221+
__replacerSlot__(pathCase) // lives/down/by/the/river
222+
__replacerSlot__(sentenceCase) // Lives down by the river
223+
__replacerSlot__(snakeCase) // lives_down_by_the_river
224+
__replacerSlot__(titleCase) // Lives Down By The River
225+
226+
// Note: you can set a 'defaultCase' converter in IConfigItem so all
227+
// Replacer Slots without a Case Converter will be transformed the same way.
228+
__replacerSlot__ // LivesDownByTheRiver
222229

223230
One Rule: no spaces between the [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) and [Case Converters](#case-converters). If there is a space, [Case Converters](#case-converters) will not work.
224231

0 commit comments

Comments
 (0)