Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Zxilly committed Feb 16, 2024
1 parent 398360c commit c05e13d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm install @zxilly/bin-wrapper

```js
import path from 'node:path';
import BinWrapper from '@xhmikosr/bin-wrapper';
import BinWrapper from '@zxilly/bin-wrapper';

const base = 'https://github.com/imagemin/gifsicle-bin/raw/main/vendor';
const bin = new BinWrapper()
Expand Down Expand Up @@ -100,6 +100,9 @@ Run the binary with the specified command. It will ensure the binary exists and

Ensure the binary exists and is executable. If not, it will download the binary and grant execution permission.

### validator(validator: Validator, os?: string, arch?: Arch): this

Add a validator for the binary.

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@zxilly/bin-wrapper",
"version": "1.0.0",
"version": "1.0.1",
"description": "Binary wrapper that makes your programs seamlessly available as local dependencies, now with TypeScript.",
"license": "MIT",
"repository": "Zxilly/bin-wrapper-ts",
Expand Down

0 comments on commit c05e13d

Please sign in to comment.