diff --git a/README.md b/README.md index e93a860..1fc3617 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@
-

Modern, lightweight, robust and extensible user interaction resolver

+

modern, lightweight, robust and extensible user gesture recognizer

@@ -72,26 +72,17 @@ $ pnpm add pointeract # yarn $ yarn add pointeract - -# bun -$ bun add pointeract ``` Or include the following lines directly in your HTML file: ```html ``` -This link ships the latest ESM version by default, to access CJS version or earlier versions, try using a different URL like: - -```html - -``` - -The link above ships version 1.0.1 in CJS. +This link ships the latest ESM version by default. Then simply grab the core class and a module: @@ -124,15 +115,15 @@ Missing your desired interaction? [Write your own module](https://pointeract.con There're already plenty of interaction libraries out there, most famous ones are `Interact.js` and `Hammer.js`, but Pointeract is different. -| Criteria | Pointeract | [Hammer.js](https://hammerjs.github.io) | [Interact.js](https://interactjs.io) | -| :--------------------------------------------------------------------------------------- | :---------------------------------------------------: | :----------------------------------------------: | :-------------------------------------------------: | -| Written in TypeScript? | ✅ | ❌ | ✅ | -| Tree-shakeable? | [✅](https://bundlephobia.com/package/pointeract) | [❌](https://bundlephobia.com/package/hammerjs) | [❌](https://bundlephobia.com/package/interactjs) | -| Bundle Size (Minified + Gzipped) | 👑 [3KB](https://bundlephobia.com/package/pointeract) | [7KB](https://bundlephobia.com/package/hammerjs) | [28KB](https://bundlephobia.com/package/interactjs) | -| Last Updated | 👑 Actively Maintained | 2015 | 2023 | -| Features | Pointer and Wheel Related | Pointer Related | 👑 Pointer and Wheel Related + Comprehensive Utils | -| Robust? (See [Testing](https://pointeract.consensia.cc/development/testing#monkey-test)) | ✅ | ❌ Element Jerks | ❌ Element Ignores the Second Touch | -| Extensible? | ✅ | ❌ | ❌ | +| Criteria | Pointeract | [Hammer.js](https://hammerjs.github.io) | [Interact.js](https://interactjs.io) | +| :-------------------------------------------------------- | :---------------------------------------------------: | :----------------------------------------------: | :-------------------------------------------------: | +| Written in TypeScript? | ✅ | ❌ | ✅ | +| Tree-shakeable? | [✅](https://bundlephobia.com/package/pointeract) | [❌](https://bundlephobia.com/package/hammerjs) | [❌](https://bundlephobia.com/package/interactjs) | +| Total Bundle Size (Minified + Gzipped) | 👑 [3KB](https://bundlephobia.com/package/pointeract) | [7KB](https://bundlephobia.com/package/hammerjs) | [28KB](https://bundlephobia.com/package/interactjs) | +| Last Updated | 👑 Actively Maintained | 2015 | 2023 | +| Features | Pointer and Wheel Related + Some Utils | Pointer Related | 👑 Pointer and Wheel Related + Comprehensive Utils | +| Robust? (See [Testing](/development/testing#monkey-test)) | ✅ | ❌ Element Jerks | ❌ Element Ignores the Second Touch | +| Extensible? | ✅ | ❌ | ❌ | ## Get Involved diff --git a/docs/en/get-started.md b/docs/en/get-started.md index 5a1ba00..465cb12 100644 --- a/docs/en/get-started.md +++ b/docs/en/get-started.md @@ -4,7 +4,7 @@ - Supported Browsers: **All Modern Browsers (IE11+)** - Supported Frameworks: **All** -- Supported Module Standards: **ESM**, **CJS** +- Supported Module Standards: **ESM** ## Installation @@ -30,19 +30,13 @@ Or include the following lines directly in your HTML file: ```html ``` -This link ships the latest ESM version by default, to access CJS version or earlier versions, try using a different URL like: +This link ships the latest ESM version by default. -```html - -``` - -The link above ships version 1.0.1 in CJS. - -## Kickstart +## Start Simply grab the core class and a module: diff --git a/package.json b/package.json index 78857aa..da9e514 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "pointeract", - "version": "1.1.0", + "version": "1.1.1", "description": "Modern, lightweight, robust and extensible user gesture recognizer.", "keywords": [ "frontend", @@ -26,9 +26,11 @@ ], "type": "module", "sideEffects": false, - "main": "./dist/index.cjs", + "main": "./dist/index.js", "module": "./dist/index.js", "types": "./dist/types/index.d.ts", + "unpkg": "./dist/index.js", + "jsdelivr": "./dist/index.js", "publishConfig": { "access": "public", "provenance": true diff --git a/vite.config.ts b/vite.config.ts index 3bf17b4..4442579 100644 --- a/vite.config.ts +++ b/vite.config.ts @@ -21,8 +21,8 @@ export default defineConfig({ index: resolve(__dirname, 'src'), }, name: 'Pointeract', - formats: ['es', 'cjs'], - fileName: (format) => `index.${format === 'cjs' ? 'cjs' : 'js'}`, + formats: ['es'], + fileName: `index.js`, }, }, test: {