Add README and vendor Cytoscape; update index.html

Add a comprehensive README describing features, usage, data model, and deployment for the OpenWrt Firewall Relationship Visualiser.

Vendor Cytoscape v3.30.4 into public/assets/js to enable local/offline graph rendering.

Update public/index.html to reference the vendored Cytoscape and accommodate the documentation/usage changes.

Author: safesploit

README.md

@@ -0,0 +1,105 @@
+# OpenWrt Firewall Relationship Visualiser
+
+A single-page browser application for visualising `/etc/config/firewall` relationships. Paste or upload an OpenWrt firewall configuration, map devices to zones, and visually inspect zone-to-zone and device-to-device connectivity.
+
+## Features
+
+- **No Backend Required** — All parsing and analysis happens in your browser; no server, database, or build step needed
+- **Local-First Privacy** — Firewall configs and device mappings stay on your computer and are saved to `localStorage`
+- **Visual Relationship Mapping** — Interactive Cytoscape.js graph showing zone and device connectivity
+- **Zone Analysis** — View zone policies, forwardings, rules, and connectivity matrix
+- **Device Path Testing** — Test specific source-to-destination reachability with optional protocol and port filters
+- **Bulk Host Import** — Import devices from host lists, ARP tables, DHCP leases, or `CSV export`
+- **Session Export/Import** — Save and restore complete analysis sessions as JSON
+- **Multiple Graph Layouts** — Force-directed, circular, and breadth-first layouts
+- **Relationship Filtering** — Show all paths, allowed only, blocked only, zone-only, or device-only relationships
+
+## Quick Start
+
+1. **Open the app**: Open [`public/index.html`](public/index.html) in any modern browser
+2. **Paste your firewall config**: Copy `/etc/config/firewall` from your OpenWrt router and paste it into the textarea
+3. **Map devices to zones**: Add devices with names, IP addresses, and their associated firewall zones (via import or manually)
+4. **Visualise relationships**: The graph renders automatically showing zones, devices, and their connectivity
+
+---
+
+### Getting Firewall Config from OpenWrt
+
+On your OpenWrt router:
+
+```bash
+cat /etc/config/firewall
+```
+
+Or copy it remotely:
+
+```bash
+scp root@<router-ip>:/etc/config/firewall ./firewall.conf
+```
+
+### Importing Devices
+
+Use the **Import** section to bulk-load devices from:
+
+- **Host lists** — Plain text format: `IP Hostname zone`
+- **Neighbour/ARP tables** — Output from `ip neighbour` or `arp -a`
+- **DHCP leases** — Output from `/tmp/dhcp.leases`
+- **OpenWrt export CSV** — Generated by the included script
+
+#### Using the Export Script
+
+The `scripts/openwrt_export_hosts.sh` script generates a CSV of all known hosts:
+
+```bash
+scp scripts/openwrt_export_hosts.sh root@<router-ip>:/tmp/
+ssh root@<router-ip> 
+sh /tmp/openwrt_export_hosts.sh
+```
+
+Output format: `ip,hostname,zone,mac`
+
+### Importing Subnet Mappings
+
+The `scripts/openwrt_export_subnet_mappings.sh` script generates UCI outputs which can be pasted into Subnet Mappings and `Import UCI Subnets`
+
+---
+
+## Technology Stack
+
+| Component | Technology |
+| --- | --- |
+| Markup | HTML5 with semantic structure |
+| Styling | Custom CSS with dark theme and CSS variables |
+| Logic | Vanilla JavaScript (no frameworks or build tools) |
+| Graph Rendering | Cytoscape.js v3.30.4 (loaded from CDN) |
+| Deployment | Static files in `public/` directory |
+
+---
+
+## Limitations
+
+- **Simplified firewall model** — Does not simulate every fw3/fw4, nftables, iptables, NAT, conntrack, or bridge behavior
+- **Manual device mapping** — Device context depends on user input (not auto-inferred)
+- **Parser scope** — Does not process include files, generated fragments, or complex quoting
+- **No protocol/port matching** — Handles common patterns but not all OpenWrt match expressions
+- **Per-browser storage** — `localStorage` is browser/profile-specific; export sessions to share
+
+---
+
+## Security & Privacy
+
+✅ **No backend** — All data stays in your browser  
+✅ **No external requests** — Cytoscape is run locally is for graph rendering 
+✅ **Safe parsing** — User-controlled strings are escaped before HTML insertion  
+✅ **Static files** — Can be hosted on any static web server with no special permissions
+✅ **Local persistence** — Uses browser `localStorage` only
+
+---
+
+## Contributing
+
+For bugs, feature requests, or improvements, see [ARCHITECTURE.md](ARCHITECTURE.md) for technical details about the codebase structure.
+
+## License
+
+See repository for license details.

public/assets/js/cytoscope_v3.30.4/cytoscape.min.js

@@ -5,7 +5,8 @@
 	<meta name="viewport" content="width=device-width, initial-scale=1.0" />
 	<title>OpenWrt Firewall Relationship Visualiser</title>
 
-	<script src="https://unpkg.com/cytoscape@3.30.4/dist/cytoscape.min.js"></script>
+	<!-- <script src="https://unpkg.com/cytoscape@3.30.4/dist/cytoscape.min.js"></script> -->
+	 <script src="assets/js/cytoscape_v3.30.4/cytoscape.min.js"></script>
 
 	<link rel="stylesheet" href="assets/css/styles.css" />
 </head>