Doc

Author: tschaub

package-lock.json

@@ -3,14 +3,18 @@
   "version": "0.0.0",
   "private": false,
   "bin": "./codemod.js",
+  "files": [
+    "./codemod.js",
+    "src"
+  ],
   "scripts": {
     "lint": "eslint eslint.config.mjs codemod.js src",
     "pretest": "npm run lint",
     "test": "vitest --run"
   },
   "description": "Applies code modifications to assist with upgrades",
   "devDependencies": {
-    "eslint": "^9.16.0",
+    "eslint": "^9.17.0",
     "eslint-config-openlayers": "^20.0.0",
     "vitest": "^2.1.8"
   },

package.json

@@ -0,0 +1,19 @@
+# @openlayers/codemod
+
+Automated code modifications to assist with OpenLayers upgrades.
+
+## replace-barrel-imports
+
+Rewrite imports from ["barrel files"](https://www.google.com/search?q=barrel+files).
+
+```bash
+# rewrite imports in all .js and .mjs files in the path/to/files directory
+npx @openlayers/codemod replace-barrel-imports path/to/files
+```
+
+See additional options with the `help` command (or `--help` flag).
+
+```bash
+# see options for the command
+npx @openlayers/codemod help replace-barrel-imports
+```