v0.2.0

README.md

@@ -1,2 +1,54 @@
-# js-buffer
-A cross platform alternative of Node buffer base on UInt8Array.
+<div align="center">
+
+<h1>@taichunmin/buffer</h1>
+
+<p>A cross platform alternative of Node buffer base on UInt8Array.</p>
+
+[![npm version](https://img.shields.io/npm/v/@taichunmin/buffer.svg?logo=npm)](https://www.npmjs.org/package/@taichunmin/buffer)
+[![jsdelivr hits](https://img.shields.io/jsdelivr/npm/hm/@taichunmin/buffer?logo=jsdelivr)](https://www.jsdelivr.com/package/npm/@taichunmin/buffer)
+[![Build status](https://img.shields.io/github/actions/workflow/status/taichunmin/js-buffer/ci.yml?branch=master)](https://github.com/taichunmin/js-buffer/actions/workflows/ci.yml)
+[![Coverage Status](https://img.shields.io/coverallsCoverage/github/taichunmin/js-buffer?branch=master)](https://coveralls.io/github/taichunmin/js-buffer?branch=master)
+[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=@taichunmin%2Fbuffer&query=$.install.pretty&label=install%20size)](https://packagephobia.now.sh/result?p=@taichunmin%2Fbuffer)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@taichunmin/buffer)](https://bundlephobia.com/package/@taichunmin/buffer@latest)
+[![npm downloads](https://img.shields.io/npm/dm/@taichunmin/buffer.svg)](https://npm-stat.com/charts.html?package=@taichunmin%2Fbuffer)
+[![GitHub contributors](https://img.shields.io/github/contributors/taichunmin/js-buffer)](https://github.com/taichunmin/js-buffer/graphs/contributors)
+[![Known vulnerabilities](https://snyk.io/test/npm/@taichunmin/buffer/badge.svg)](https://snyk.io/test/npm/@taichunmin/buffer)
+[![MIT License](https://img.shields.io/github/license/taichunmin/js-buffer)](https://github.com/taichunmin/js-buffer/blob/master/LICENSE)
+
+</div>
+
+## Getting Started
+
+Use npm or yarn to install the package.
+
+```bash
+# npm
+npm install @taichunmin/buffer
+
+# yarn
+yarn add @taichunmin/buffer
+```
+
+Use jsdelivr CDN to include the package.
+
+```html
+<!-- script -->
+<script src="https://cdn.jsdelivr.net/npm/@taichunmin/buffer@0/dist/buffer.global.js"></script>
+
+<!-- module -->
+<script type="module">
+  import { Buffer } from 'https://cdn.jsdelivr.net/npm/@taichunmin/buffer@0/dist/buffer.global.js'
+</script>
+
+<!-- module + importmap -->
+<script type="importmap">
+  {
+    "imports": {
+      "lodash": "https://cdn.jsdelivr.net/npm/lodash@4/lodash.min.js"
+    }
+  }
+</script>
+<script type="module">
+  import { Buffer } from 'https://cdn.jsdelivr.net/npm/@taichunmin/buffer@0/dist/buffer.mjs'
+</script>
+```

package.json

@@ -1,13 +1,28 @@
 {
-  "author": "taichunmin <taichunmin@gmail.com>",
+  "browser": "dist/buffer.global.js",
+  "description": "A cross platform alternative of Node buffer base on UInt8Array.",
+  "homepage": "https://github.com/taichunmin/js-buffer",
+  "jsdelivr": "dist/buffer.global.js",
   "license": "MIT",
   "main": "index.js",
   "name": "@taichunmin/buffer",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/taichunmin/js-buffer.git"
+  "unpkg": "dist/buffer.global.js",
+  "version": "0.2.0",
+  "author": {
+    "email": "taichunmin@gmail.com",
+    "name": "Chunmin Tai",
+    "url": "https://taichunmin.idv.tw"
   },
-  "version": "0.1.0",
+  "bugs": {
+    "url": "https://github.com/taichunmin/js-buffer/issues"
+  },
+  "contributors": [
+    {
+      "email": "taichunmin@gmail.com",
+      "name": "Chunmin Tai",
+      "url": "https://taichunmin.idv.tw"
+    }
+  ],
   "dependencies": {
     "lodash": "^4.17.21",
     "utility-types": "^3.11.0"
@@ -27,12 +42,39 @@
     "tsup": "^8.0.2",
     "typescript": "^5.4.5"
   },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "browser": "./dist/buffer.global.js",
+      "import": {
+        "default": "./dist/buffer.mjs",
+        "types": "./dist/buffer.d.mts"
+      },
+      "require": {
+        "default": "./dist/buffer.js",
+        "types": "./dist/buffer.d.ts"
+      }
+    }
+  },
+  "keywords": [
+    "arraybuffer",
+    "browser",
+    "browserify",
+    "buffer",
+    "compatible",
+    "dataview",
+    "uint8array"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/taichunmin/js-buffer.git"
+  },
   "scripts": {
     "build": "tsup",
-    "lint:ci": "eslint --ext ts --fix ./lib",
     "lint": "yarn lint:ci --fix",
+    "lint:ci": "eslint --ext ts --fix ./lib",
     "publish:test": "npm publish --access public --dry-run",
-    "test:ci": "jest --roots ./lib --ci --coverage",
-    "test": "jest --roots ./lib --"
+    "test": "jest --roots ./lib --",
+    "test:ci": "jest --roots ./lib --ci --coverage"
   }
-}
+}

tsup.config.ts

@@ -7,5 +7,5 @@ export default defineConfig({
   format: ['cjs', 'esm', 'iife'],
   minify: true,
   sourcemap: true,
-  splitting: false
+  splitting: false,
 })