@yuneta/gobj-js 0.3.0

package/README.md

@@ -0,0 +1,71 @@
+# README
+
+## Install
+
+This project uses [`vite`](https://vite.dev/) as build tool.
+
+Install the latest `node`:
+
+    nvm install --lts
+
+When writing this readme the LTS version was:
+
+    node --version
+        v22.14.0
+
+    npm install -g vite
+
+Install dependencies:
+
+    npm install
+
+To start Vite dev server:
+
+    vite
+
+To build:
+
+    vite build
+
+To publish a new version of @yuneta/gobj-js to [npmjs.com](https://www.npmjs.com/package/@yuneta/gobj-js):
+
+    # 1. Configure your npm token (only once)
+    echo "//registry.npmjs.org/:_authToken=<your-token>" > ~/.npmrc
+
+    # 2. Update the version in package.json
+    npm version patch   # or minor / major
+
+    # 3. Publish (build runs automatically via prepublishOnly)
+    npm publish --access public
+
+To create an npm token, go to [npmjs.com](https://www.npmjs.com) → Account → Access Tokens.
+
+To test:
+
+    npm test
+
+or
+
+    npx vitest
+
+or
+
+    npx vitest --watch  # automatically re-run tests when files change,
+
+or
+
+    npm run test:coverage
+
+## Update
+
+ONLY one time: to update all js packages, install the module::
+
+    npm install -g npm-check-updates
+
+To download new releases::
+
+    ncu -u
+
+And to install the new versions::
+
+    npm install