diff --git a/packages/change-case/README.md b/packages/change-case/README.md index ac683289..9085c9b6 100644 --- a/packages/change-case/README.md +++ b/packages/change-case/README.md @@ -16,7 +16,7 @@ import * as changeCase from "change-case"; changeCase.camelCase("TEST_VALUE"); //=> "testValue" ``` -Included case functions: +### Built-in methods | Method | Result | | ----------------- | ----------- | @@ -33,6 +33,8 @@ Included case functions: | `snakeCase` | `two_words` | | `trainCase` | `Two-Words` | +**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). + All methods accept an `options` object as the second argument: - `delimiter?: string` The character to use between words. Default depends on method, e.g. `_` in snake case.