solid-logic 3.0.9-78ce629 → 3.0.9-a1c02ec

package/README.md

@@ -7,9 +7,90 @@
 
 Core business logic of SolidOS which can be used for any webapp as well.
 
-# How to use
 
-Either `npm install solid-logic` or in your HTML use directly `solid-logic.js` from `dist` folder.
+# Usage
+
+## Install via npm
+
+```sh
+npm install solid-logic
+```
+
+### Import in your project (ESM/TypeScript)
+
+```js
+import { someFunction } from 'solid-logic';
+```
+
+## Use directly in a browser
+
+There are a few differences to mention:
+* the UMD bundles come in 2 flavours, with rdflib bundled together and without;
+* the ESM bundles do not contain rdflib, so it must be imported separately.
+
+## Files
+- For npm/ESM: `dist/solid-logic.esm.js` (referenced automatically in npm projects)
+- For browser UMD, bundled with rdflib: `dist/solid-logic.umd.js` (global `window.SolidLogic`)
+- For browser UMD, without rdflib: `dist/solid-logic.umd.external.js` (global `window.SolidLogic`)
+- For browser ESM, without rdflib: `dist/solid-logic.esm.external.js` (import as module)
+- also, both flabours, ESM and UMD come in chunked files.
+
+
+### UMD bundle (global variable)
+
+```html
+<!-- Load dependencies first -->
+<script src="https://unpkg.com/rdflib/dist/rdflib.min.js"></script>
+<!-- or -->
+<!-- script src="https://cdn.jsdelivr.net/npm/rdflib/dist/rdflib.min.js"></script -->
+<!-- Load solid-logic UMD bundle -->
+<script src="https://unpkg.com/solid-logic/dist/solid-logic.umd.min.js"></script>
+<!-- or -->
+<!-- script src="https://cdn.jsdelivr.net/npm/solid-logic/dist/solid-logic.umd.min.js"></script -->
+<!-- or -->
+<!-- script src="dist/solid-logic.umd.js"></script -->
+<script>
+	// Access via global variable
+	const logic = window.SolidLogic;
+	// Example usage
+	// logic.someFunction(...)
+</script>
+```
+
+
+### ESM bundle (import as module)
+
+```html
+<script type="module">
+	import * as $rdf from 'https://esm.sh/rdflib'
+	import { someFunction } from 'https://esm.sh/solid-logic'
+
+	// Example usage
+	// someFunction(...)
+</script>
+```
+
+or 
+
+### ESM bundle with import map (bare specifiers)
+
+```html
+<script type="importmap">
+{
+	"imports": {
+		"rdflib": "https://esm.sh/rdflib",
+		"solid-logic": "https://esm.sh/solid-logic"
+	}
+}
+</script>
+<script type="module">
+    import * as $rdf from 'rdflib'
+	import { someFunction } from 'solid-logic'
+
+	// Example usage
+	// someFunction(...)
+</script>
+```
 
 # How to develop
 
@@ -22,6 +103,10 @@ Check the scripts in the `package.json` for build, watch, lint and test.
 * ESLint
 * Rollup
 
+# How to release
+
+Change version and push directly to main. This will trigger the npm release latest script in CI.
+
 # History
 
 Solid-logic was a move to separate business logic from UI functionality so that people using different UI frameworks could use logic code. 

package/dist/789.solid-logic.umd.js

@@ -0,0 +1,11 @@
+(this["webpackChunkSolidLogic"] = this["webpackChunkSolidLogic"] || []).push([[789],{
+
+/***/ 7789:
+/***/ (() => {
+
+/* (ignored) */
+
+/***/ })
+
+}]);
+//# sourceMappingURL=789.solid-logic.umd.js.map

package/dist/789.solid-logic.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"789.solid-logic.umd.js","mappings":";;;;;AAAA,e","sources":["webpack://SolidLogic/ignored|/home/runner/work/solid-logic/solid-logic/node_modules/rdf-canonize/lib|rdf-canonize-native"],"sourcesContent":["/* (ignored) */"],"names":[],"sourceRoot":""}

package/dist/789.solid-logic.umd.min.js

@@ -0,0 +1 @@
+(this.webpackChunkSolidLogic=this.webpackChunkSolidLogic||[]).push([[789],{7789:()=>{}}]);