Skip to content

Commit fcd9073

Browse files
committed
more copy refinement
1 parent ab5fd79 commit fcd9073

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ npm install segment-string
3131

3232
## Getting Started
3333

34-
`segment-string` is a lightweight wrapper for `Intl.Segmenter`, designed to simplify locale-sensitive text segmentation in JavaScript and TypeScript. It lets you easily split text by graphemes, words, or sentences, ideal for handling complex cases like multi-character emojis or language-specific boundaries.
34+
`segment-string` is a lightweight wrapper for `Intl.Segmenter`, designed to simplify locale-sensitive text segmentation in JavaScript and TypeScript. It lets you easily segment and manipulate text by graphemes, words, or sentences, ideal for handling complex cases like multi-character emojis or language-specific boundaries.
3535

3636
```typescript
3737
import { SegmentString } from "segment-string";
@@ -139,6 +139,10 @@ Returns the sentence at a specific index, supporting negative indices.
139139

140140
Returns the raw sentence data at a specific index, supporting negative indices.
141141

142+
### `[Symbol.iterator](): Iterator<string>`
143+
144+
Returns an iterator over the graphemes of the string.
145+
142146
---
143147

144148
## Example Usage

0 commit comments

Comments
 (0)