Skip to content

Commit

Permalink
Add tip to README about title case
Browse files Browse the repository at this point in the history
  • Loading branch information
blakeembrey committed Apr 18, 2024
1 parent 8aaff31 commit 759c9a5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion packages/change-case/README.md
Expand Up @@ -16,7 +16,7 @@ import * as changeCase from "change-case";
changeCase.camelCase("TEST_VALUE"); //=> "testValue"
```

Included case functions:
### Built-in methods

| Method | Result |
| ----------------- | ----------- |
Expand All @@ -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.
Expand Down

0 comments on commit 759c9a5

Please sign in to comment.