Skip to content

Commit

Permalink
docs(imago): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
postspectacular committed Jul 6, 2024
1 parent 90258b2 commit e14762c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
7 changes: 5 additions & 2 deletions packages/imago/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)

> [!NOTE]
> This is one of 189 standalone projects, maintained as part
> This is one of 188 standalone projects, maintained as part
> of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
> and anti-framework.
>
Expand Down Expand Up @@ -258,6 +258,9 @@ Alternatively, a
the image can be computed and stored in the outputs. In this case, no file will
be written.

For all other formats, if no output path is provided in the spec, no file will
be written, but the encoded image buffer itself will be recorded in the outputs.

#### Templated output paths

Output paths can contain `{id}`-templated parts which will be replaced/expanded.
Expand Down Expand Up @@ -357,7 +360,7 @@ For Node.js REPL:
const imago = await import("@thi.ng/imago");
```

Package sizes (brotli'd, pre-treeshake): ESM: 4.92 KB
Package sizes (brotli'd, pre-treeshake): ESM: 4.95 KB

## Dependencies

Expand Down
3 changes: 3 additions & 0 deletions packages/imago/tpl.readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,9 @@ Alternatively, a
the image can be computed and stored in the outputs. In this case, no file will
be written.

For all other formats, if no output path is provided in the spec, no file will
be written, but the encoded image buffer itself will be recorded in the outputs.

#### Templated output paths

Output paths can contain `{id}`-templated parts which will be replaced/expanded.
Expand Down

0 comments on commit e14762c

Please sign in to comment.