Skip to content

Commit 759c9a5

Browse files
committed
Add tip to README about title case
1 parent 8aaff31 commit 759c9a5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

packages/change-case/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import * as changeCase from "change-case";
1616
changeCase.camelCase("TEST_VALUE"); //=> "testValue"
1717
```
1818

19-
Included case functions:
19+
### Built-in methods
2020

2121
| Method | Result |
2222
| ----------------- | ----------- |
@@ -33,6 +33,8 @@ Included case functions:
3333
| `snakeCase` | `two_words` |
3434
| `trainCase` | `Two-Words` |
3535

36+
**Tip:** Change case assumes you are switching between different programming cases. It does not retain punctuation or other sensitivities. For example, `WOW! That's crazy.` would be `wowThatSCrazy` in camel case. If you're looking for a more generic title/sentence case library, consider trying [title-case](https://github.com/blakeembrey/change-case/blob/main/packages/title-case/README.md).
37+
3638
All methods accept an `options` object as the second argument:
3739

3840
- `delimiter?: string` The character to use between words. Default depends on method, e.g. `_` in snake case.

0 commit comments

Comments
 (0)