Skip to content

Commit

Permalink
docs: fix CLI usage documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
  • Loading branch information
jerome-benoit committed Jul 9, 2024
1 parent 6fbd9c8 commit 33735e3
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ dist
# Finder (MacOS) folder config
.DS_Store

tatami
target/
*.orig
deno.lock
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@
- [CLI installation](#cli-installation)
- [Node](#node-1)
- [Bun](#bun-1)
- [Deno](#deno-1)
<!-- - [Deno](#deno-1) -->
- [CLI standalone binary](#cli-standalone-binary)
- [CLI usage examples](#cli-usage-examples)
- [Development](#development)
- [License](#license)
Expand Down Expand Up @@ -158,16 +159,31 @@ npm install tatami-ng -g
bun add tatami-ng -g
```

### Deno
Ensure the global installation directory is in your path:

- Unix: `${HOME}/.bun/bin`
- Windows: TODO

<!-- ### Deno -->

## CLI standalone binary

In the cloned repository root directory, run:

```shell
deno install --allow-sys --allow-read --allow-hrtime --name tatami https://esm.sh/jsr/@poolifier/tatami-ng/cli.js
deno compile --allow-read ---allow-run --allow-sys -allow-hrtime --output=tatami ./cli.js
```

The standalone binary can be moved to a directory in your path.

## CLI usage examples

```shell
tatami 'hexdump <file>' 'xxd <file>'
tatami --help
```

```shell
tatami --bench 'hexdump <file>' --bench 'xxd <file>'
```

## Development
Expand Down
2 changes: 1 addition & 1 deletion cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ const {
},
},
description: 'tatami-ng CLI for running benchmark',
examples: ['--baseline <command> --bench <command> --bench <command>'],
examples: ["--baseline '<command>' --bench '<command>' --bench '<command>'"],
name: 'tatami',
pkg,
})
Expand Down

0 comments on commit 33735e3

Please sign in to comment.