@arbocollab/arbo-web-search 1.0.1 → 1.0.4

package/README.md

@@ -3,3 +3,61 @@
 This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
 
 Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
+
+
+# JsDelivr expected output:
+
+Accessible from:
+https://cdn.jsdelivr.net/npm/<package-name\>@<version\>/<file-path\>
+
+#### Example:
+\<script src="https://cdn.jsdelivr.net/npm/gs@latest/gs.umd.min.js">\</script>
+
+
+#### Auto-resolving main fle
+- Define "main" file in package.json
+
+```
+
+{
+  "main": "dist/gs.umd.min.js"      // global all browsers
+  "module": "dist/gsm.esm.js"       // ESM modern browsers
+  "browser": dist/gs.umd.min.js",   // fallback for browsers
+  "files" : ["dist"],               // push the dist folder
+  ...
+```
+
+# How to publish to NpmJS?
+
+- UMD/ESM build => prefer UMD minified
+  
+- register npmjs registry entry in .npmrc
+  
+- npm run build --mode=production
+
+- npm publish (to npmJS, ONLY dist/.umd file)
+
+# Live publish using makefile
+
+## i. Preparation
+
+- Update dependencies to live version: `"@arbocollab/arbo-ui-components": "npm:@arbocollab/arbo-ui-components@^1.x.xxx",`
+
+- Change `"version": "1.x.x",`
+
+## ii. Publish to NpmJS & JsDelivr CDN
+
+- Publish using Makefile instruction:
+  
+- Install
+  `make install`
+
+- Build for production
+  `make build-production`
+
+- Publish to npmjs public package repository
+  `make publish-npmjs`
+
+- Clear cdn cache
+  `make purge-cdn-cache`
+  ```