Skip to content

chore: improve package and readme structure #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
targos merged 1 commit into from
Jun 15, 2025
Merged

chore: improve package and readme structure #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ Read and write binary data in ArrayBuffers.
## Installation

```console
npm i iobuffer
npm install iobuffer
```

## API

Complete [API documentation](http://image-js.github.io/iobuffer/)
### [Complete API documentation](https://image-js.github.io/iobuffer/)

## Usage example
### Usage example

```js
const { IOBuffer } = require('iobuffer');
Expand Down
26 changes: 13 additions & 13 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"name": "iobuffer",
"version": "5.4.0",
"license": "MIT",
"description": "Read and write binary data on ArrayBuffers",
"author": "Michaël Zasso",
"type": "module",
"exports": "./lib/iobuffer.js",
"files": [
Expand All @@ -10,9 +12,9 @@
],
"scripts": {
"check-types": "tsc --noEmit",
"clean": "rimraf lib",
"clean": "rimraf coverage lib",
"eslint": "eslint .",
"eslint-fix": "npm run eslint -- --fix",
"eslint-fix": "eslint . --fix",
"prepack": "npm run tsc",
"prettier": "prettier --check .",
"prettier-write": "prettier --write .",
Expand All @@ -21,16 +23,6 @@
"tsc": "npm run clean && npm run tsc-build",
"tsc-build": "tsc --project tsconfig.build.json"
},
"repository": {
"type": "git",
"url": "git+https://github.com/image-js/iobuffer.git"
},
"author": "Michaël Zasso",
"license": "MIT",
"bugs": {
"url": "https://github.com/image-js/iobuffer/issues"
},
"homepage": "https://github.com/image-js/iobuffer#readme",
"devDependencies": {
"@types/node": "^22.15.29",
"@vitest/coverage-v8": "^3.1.4",
Expand All @@ -41,5 +33,13 @@
"rimraf": "^6.0.1",
"typescript": "^5.8.3",
"vitest": "^3.1.4"
}
},
"repository": {
"type": "git",
"url": "git+https://github.com/image-js/iobuffer.git"
},
"bugs": {
"url": "https://github.com/image-js/iobuffer/issues"
},
"homepage": "https://image-js.github.io/iobuffer/"
}