Skip to content

Commit

Permalink
docs: regenerate/update all readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
postspectacular committed Sep 9, 2021
1 parent 9692525 commit a7e1969
Show file tree
Hide file tree
Showing 154 changed files with 2,071 additions and 765 deletions.
18 changes: 13 additions & 5 deletions packages/adapt-dpi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,23 @@ buffer itself based on DPR (e.g. 2x size).
yarn add @thi.ng/adapt-dpi
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/adapt-dpi?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/adapt-dpi"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/adapt-dpi/lib/index.umd.js" crossorigin></script>
> const adaptDpi = await import("@thi.ng/adapt-dpi");
```

Package sizes (gzipped, pre-treeshake): ESM: 150 bytes / CJS: 198 bytes / UMD: 316 bytes
Package sizes (gzipped, pre-treeshake): ESM: 150 bytes

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/adjacency/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,23 @@ Sparse & bitwise adjacency matrices and related functions for directed & undirec
yarn add @thi.ng/adjacency
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/adjacency?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/adjacency"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/adjacency/lib/index.umd.js" crossorigin></script>
> const adjacency = await import("@thi.ng/adjacency");
```

Package sizes (gzipped, pre-treeshake): ESM: 2.31 KB / CJS: 2.40 KB / UMD: 2.46 KB
Package sizes (gzipped, pre-treeshake): ESM: 2.31 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,23 @@ repository. It defines:
yarn add @thi.ng/api
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/api?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/api"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/api/lib/index.umd.js" crossorigin></script>
> const api = await import("@thi.ng/api");
```

Package sizes (gzipped, pre-treeshake): ESM: 2.18 KB / CJS: 2.35 KB / UMD: 2.27 KB
Package sizes (gzipped, pre-treeshake): ESM: 2.18 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/args/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,23 @@ individual values, e.g. `-a 1,2,3` equals `-a 1 -a 2 -a 3`
yarn add @thi.ng/args
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/args?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/args"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/args/lib/index.umd.js" crossorigin></script>
> const args = await import("@thi.ng/args");
```

Package sizes (gzipped, pre-treeshake): ESM: 2.40 KB / CJS: 2.53 KB / UMD: 2.44 KB
Package sizes (gzipped, pre-treeshake): ESM: 2.40 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/arrays/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,23 @@ Array / Arraylike utilities.
yarn add @thi.ng/arrays
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/arrays?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/arrays"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/arrays/lib/index.umd.js" crossorigin></script>
> const arrays = await import("@thi.ng/arrays");
```

Package sizes (gzipped, pre-treeshake): ESM: 2.08 KB / CJS: 2.27 KB / UMD: 2.23 KB
Package sizes (gzipped, pre-treeshake): ESM: 2.08 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/associative/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,15 +168,23 @@ map.get([3,4], "n/a");
yarn add @thi.ng/associative
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/associative?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/associative"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/associative/lib/index.umd.js" crossorigin></script>
> const associative = await import("@thi.ng/associative");
```

Package sizes (gzipped, pre-treeshake): ESM: 6.29 KB / CJS: 6.49 KB / UMD: 6.26 KB
Package sizes (gzipped, pre-treeshake): ESM: 6.30 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/atom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,23 @@ have been removed.
yarn add @thi.ng/atom
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/atom?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/atom"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/atom/lib/index.umd.js" crossorigin></script>
> const atom = await import("@thi.ng/atom");
```

Package sizes (gzipped, pre-treeshake): ESM: 1.83 KB / CJS: 1.90 KB / UMD: 1.95 KB
Package sizes (gzipped, pre-treeshake): ESM: 1.83 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/base-n/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,23 @@ Arbitrary base-n conversions w/ presets for base16/32/36/58/62/64/85, support fo
yarn add @thi.ng/base-n
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/base-n?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/base-n"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/base-n/lib/index.umd.js" crossorigin></script>
> const baseN = await import("@thi.ng/base-n");
```

Package sizes (gzipped, pre-treeshake): ESM: 817 bytes / CJS: 925 bytes / UMD: 1001 bytes
Package sizes (gzipped, pre-treeshake): ESM: 817 bytes

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/bench/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,23 @@ still only sourced via `Date.now()`.
yarn add @thi.ng/bench
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/bench?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/bench"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/bench/lib/index.umd.js" crossorigin></script>
> const bench = await import("@thi.ng/bench");
```

Package sizes (gzipped, pre-treeshake): ESM: 1.37 KB / CJS: 1.47 KB / UMD: 1.47 KB
Package sizes (gzipped, pre-treeshake): ESM: 1.39 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/bencode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,23 @@ semi-open `[1e-6,1e21)` interval can be encoded.
yarn add @thi.ng/bencode
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/bencode?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/bencode"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/bencode/lib/index.umd.js" crossorigin></script>
> const bencode = await import("@thi.ng/bencode");
```

Package sizes (gzipped, pre-treeshake): ESM: 1.17 KB / CJS: 1.23 KB / UMD: 1.30 KB
Package sizes (gzipped, pre-treeshake): ESM: 1.17 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/binary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,23 @@ This project is part of the
yarn add @thi.ng/binary
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/binary?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/binary"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/binary/lib/index.umd.js" crossorigin></script>
> const binary = await import("@thi.ng/binary");
```

Package sizes (gzipped, pre-treeshake): ESM: 2.06 KB / CJS: 2.40 KB / UMD: 2.04 KB
Package sizes (gzipped, pre-treeshake): ESM: 2.06 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/bitfield/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,23 @@ backing the width is always rounded to a multiple of 32.
yarn add @thi.ng/bitfield
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/bitfield?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/bitfield"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/bitfield/lib/index.umd.js" crossorigin></script>
> const bitfield = await import("@thi.ng/bitfield");
```

Package sizes (gzipped, pre-treeshake): ESM: 1.14 KB / CJS: 1.19 KB / UMD: 1.29 KB
Package sizes (gzipped, pre-treeshake): ESM: 1.14 KB

## Dependencies

Expand Down
18 changes: 13 additions & 5 deletions packages/bitstream/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,23 @@ ES6 iterator based read/write bit streams with support for variable word widths.
yarn add @thi.ng/bitstream
```

ES module import:

```html
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/bitstream?module" crossorigin></script>
<script type="module" src="https://cdn.skypack.dev/@thi.ng/bitstream"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For NodeJS (v14.6+):

```text
node --experimental-specifier-resolution=node --experimental-repl-await
// UMD
<script src="https://unpkg.com/@thi.ng/bitstream/lib/index.umd.js" crossorigin></script>
> const bitstream = await import("@thi.ng/bitstream");
```

Package sizes (gzipped, pre-treeshake): ESM: 1.09 KB / CJS: 1.15 KB / UMD: 1.22 KB
Package sizes (gzipped, pre-treeshake): ESM: 1.09 KB

## Dependencies

Expand Down
Loading

0 comments on commit a7e1969

Please sign in to comment.