Add license

Author: t-ski

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Thassilo M. Schiepanski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,32 +1,77 @@
-# D2Snap
+<h1 align="center">D2Snap</h1>
 
 ![Example of downsampling on an image (top) and a DOM (bottom) instance](./.github/downsampling.png)
 
-**D2Snap** is a first-of-its-kind DOM downsampling algorithm, designed for use with LLM-based web agents.  
+**D2Snap** is a first-of-its-kind DOM downsampling algorithm, designed for use with LLM-based web agents.
 
-### Setup
+##
+
+### Integrate
+
+``` ts
+D2Snap.d2Snap(
+  dom: DOM,
+  k: number, l: number, m: number,
+  options?: Options
+): Promise<string>
+
+D2Snap.d2Snap(
+  dom: DOM,
+  maxTokens: number = 4096,
+  maxIterations: number = 5,
+  options?: Options
+): Promise<string>
+```
+
+``` ts
+type DOM = Document | Element | string;
+type Options = {
+  assignUniqueIDs?: boolean; // false
+  debug?: boolean;           // true
+};
+```
+
+#### Browser
+
+``` html
+<script src="https://cdn.jsdelivr.net/gh/surfly/D2Snap@main/dist/D2Snap.browser.js"></script>
+```
+
+#### Module
 
 ``` console
-npm install
+npm install surfly/D2Snap
 ```
 
-> Provide LLM API provider key(s) to .env (compare [example](./.env.example)).
+``` js
+import { d2Snap, adaptiveD2Snap } from "@surfly/d2snap";
+```
+
+##
 
-## 
+### Experiment
 
-### Build
+#### Setup
+
+``` console
+npm install
+```
+
+#### Build
 
 ``` console
 npm run build
 ```
 
-### Test
+#### Test
 
 ``` console
 npm run test
 ```
 
-### Evaluate
+#### Evaluate
+
+> Provide LLM API provider key(s) to .env (compare [example](./.env.example)).
 
 ``` console
 npm run eval:<snapshot>
@@ -38,8 +83,20 @@ npm run eval:<snapshot>
 npm run eval:D2Snap -- --verbose --split 10,20 --provider openai --model gpt-4o
 ```
 
-### Re-create Snapshots
+#### Re-create Snapshots
 
 ``` console
 npm run snapshots:create
-```
+```
+
+##
+
+<p align="center">
+    <strong>Beyond Pixels: Exploring DOM Downsampling for LLM-Based Web Agents</strong>
+    <br>
+    <sub><a href="https://github.com/t-ski" target="_blank">Thassilo M. Schiepanski</a></sub>
+    &hairsp;
+    <sub><a href="https://nl.linkedin.com/in/nicholasp" target="_blank">Nicholas Piël</a></sub>
+    <br>
+    <sub>Surfly BV</sub>
+</p>

inject/_inject.js

@@ -10,16 +10,16 @@ document
         console.log(document.body.innerHTML);
 
         presentSnapshot(
-            await D2Snap.d2Snap(2, 5, 0.375, {
+            await D2Snap.d2Snap(0.7, 0.7, 0.7, {
                 debug: true
             }),
-            { k: 2, l: 5, m: 0.375 }
+            { k: 0.7, l: 0.7, m: 0.7 }
         );
         presentSnapshot(
-            await D2Snap.d2Snap(4, 2, 0.6, {
+            await D2Snap.d2Snap(0.2, 0.4, 0.6, {
                 debug: true
             }),
-            { k: 4, l: 2, m: 0.6 }
+            { k: 0.2, l: 0.4, m: 0.6 }
         );
         presentSnapshot(
             await D2Snap.adaptiveD2Snap(undefined, undefined, {

package.json

@@ -1,5 +1,7 @@
 {
   "private": true,
+  "name": "@surfly/d2snap",
+  "version": "1.0.0",
   "author": "Thassilo M. Schiepanski",
   "type": "module",
   "scripts": {