ngraph.svg 0.0.15 → 0.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Andrei Kashcha
+Copyright (c) 2014-2025 Andrei Kashcha
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -10,6 +10,45 @@ With [npm](https://npmjs.org) do:
 npm install ngraph.svg
 ```
 
+# dev/build
+
+This repo now uses native ES modules and Vite for development and library build:
+
+- Start examples: `npm run dev` (opens `/example/basic/index.html`).
+- Build library: `npm run build`.
+- Preview build: `npm run preview`.
+
+Basic ESM usage:
+
+```js
+import createGraph from 'ngraph.graph';
+import createRenderer from 'ngraph.svg';
+
+const graph = createGraph();
+graph.addLink('a', 'b');
+
+const renderer = createRenderer(graph);
+renderer.run();
+```
+
+## Standalone browser build
+
+If you prefer a single script without bundlers, build the standalone bundle and include it directly in the browser. It exposes a global `ngraphSvg`.
+
+```html
+<!-- After running: npm run build:standalone -->
+<script src="./dist/ngraph.svg.standalone.js"></script>
+<script type="module">
+	import createGraph from 'https://unpkg.com/ngraph.graph@20?module';
+	const graph = createGraph();
+	graph.addLink('a', 'b');
+	const renderer = ngraphSvg(graph);
+	renderer.run();
+<\/script>
+```
+
+Note: The standalone build bundles this library's dependencies, but you still need to provide a graph instance (e.g. from `ngraph.graph`).
+
 # license
 
 MIT