Skip to content

Commit 4690e69

Browse files
committed
docs: when should i use this?
Signed-off-by: Lexus Drumgold <[email protected]>
1 parent 977cc56 commit 4690e69

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ events, with the tokenizer calling any defined resolvers in the process.
3030

3131
## When should I use this?
3232

33-
**TODO**: when should I use this?
33+
This package can be used to tokenize a [file][vfile], `Uint8Array`, string, or a list containing these values,
34+
like command-line arguments. Developers familiar with [micromark][] will find that tokenizers and constructs (objects
35+
used to define how to parse text) in this package work similarly.
3436

3537
## Install
3638

@@ -88,6 +90,10 @@ community you agree to abide by its terms.
8890

8991
[esmsh]: https://esm.sh
9092

93+
[micromark]: https://github.com/micromark/micromark
94+
9195
[typescript]: https://www.typescriptlang.org
9296

97+
[vfile]: https://github.com/vfile/vfile
98+
9399
[yarn]: https://yarnpkg.com

0 commit comments

Comments
 (0)