diff --git a/README.md b/README.md index db92007..ad8c976 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ npm add content-tag-utils Using from source / github, via package.json: -```js +```json { "dependencies": { "content-tag-utils": "github:NullVoxPopuli/content-tag-utils" @@ -46,7 +46,7 @@ import { unprocess } from 'content-tag-utils/unprocess'; ### Transformer -A general utility for working with content-tag, keeping tracked of each template as you apply transformations. +A general utility for working with content-tag, keeping track of each template as you apply transformations. Transformations are recorded and then applied later when calling `.toString()`. For example: @@ -63,7 +63,7 @@ export const Foo = '` ### transform + transformSync Transforms each template within a gjs or gts file in one go. -These are convenience functions that wraps the `Transformer`. +These are convenience functions that wrap the `Transformer`. The first argument to the callback will be the previous template-contents, and the second argument will be the coordinates of that template. @@ -127,7 +129,7 @@ let result = await transform(file, (contents, coordinates) => `${contents}!`); let result2 = transformSync(file, (contents, coordinates) => `${contents}!`); ``` -result / result 2 ( a ! character is added right before the closing ): +result / result 2 (a `!` character is added right before the closing ``): ```gjs export const Foo =