data-navigator 2.2.1 → 2.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Carnegie Mellon University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# Data Navigator
+
+![Data Navigator provides visualization toolkits with rich, accessible navigation structures, robust input handling, and flexible, semantic rendering.](https://raw.githubusercontent.com/cmudig/data-navigator/main/assets/data_navigator.png)
+
+Data Navigator is a JavaScript library that enables keyboard, screen reader, and multi-modal navigation of data structures and visualizations. It works with any rendering technology — SVG, Canvas, images, or WebGL — by creating a semantic, accessible HTML layer on top of your graphics.
+
+**[Documentation](https://dig.cmu.edu/data-navigator/)** · **[Getting Started](https://dig.cmu.edu/data-navigator/getting-started/)** · **[Demo](https://dig.cmu.edu/data-navigator/demo)** · **[npm](https://www.npmjs.com/package/data-navigator)**
+
+## Install
+
+```
+npm install data-navigator
+```
+
+```js
+import dataNavigator from 'data-navigator';
+```
+
+## How it works
+
+Data Navigator is organized into 3 composable modules:
+
+1. **Structure** — a graph of nodes and edges that defines navigation paths through your data
+2. **Input** — handles keyboard, touch, voice, gesture, and custom input modalities
+3. **Rendering** — creates semantic HTML elements overlaid on your visualization
+
+These modules can be used together or independently. Visit [the docs](https://dig.cmu.edu/data-navigator/getting-started/) for a step-by-step guide to building your first navigable chart.
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions and development workflow.
+
+## Credit
+
+Data Navigator was developed at CMU's [Data Interaction Group](https://dig.cmu.edu/) (CMU DIG), primarily by [Frank Elavsky](https://frank.computer).
+
+## Citing Data Navigator
+
+```bib
+@article{2023-data-navigator,
+  title = {{Data Navigator}: An Accessibility-Centered Data Navigation Toolkit},
+  publisher = {{IEEE}},
+  author = {Frank Elavsky and Lucas Nadolskis and Dominik Moritz},
+  journal = {{IEEE} Transactions on Visualization and Computer Graphics},
+  year = {2023},
+  url = {http://dig.cmu.edu/data-navigator/}
+}
+```

package/package.json

@@ -1,13 +1,15 @@
 {
     "name": "data-navigator",
     "author": "Frank Elavsky",
-    "version": "2.2.1",
+    "version": "2.2.2",
     "type": "module",
     "main": "./dist/index.cjs",
     "module": "./dist/index.js",
     "types": "./dist/src/index.d.ts",
     "files": [
-        "dist/**/*"
+        "dist/**/*",
+        "README.md",
+        "LICENSE"
     ],
     "exports": {
         ".": {
@@ -32,7 +34,8 @@
         "clean": "rm -rf ./dist",
         "build": "yarn build:index && yarn build:modules",
         "build:index": "tsup src/index.ts --format cjs,esm",
-        "build:modules": "tsup src/structure.ts src/input.ts src/rendering.ts src/utilities.ts src/consts.ts --format cjs,esm --minify"
+        "build:modules": "tsup src/structure.ts src/input.ts src/rendering.ts src/utilities.ts src/consts.ts --format cjs,esm --minify",
+        "prepublishOnly": "cp ../../README.md ../../LICENSE ."
     },
     "devDependencies": {
         "@swc/core": "^1.3.75",