diff --git a/README.md b/README.md index fc8c416..f8347f8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,22 @@ # Zap +

+ Zap icon +

+ Peer-to-peer local network file transfer in the browser using WebRTC. Zap is a local-first web app for quickly sending files between devices on the same LAN/hotspot. The server is only for peer discovery and signaling; file data is transferred directly between browsers. +## Useful Scenarios + +1. **Unstable or no outside internet, but local network still works** + Teams on the same Wi-Fi/LAN can still share files, post quick session chat updates, and use shared clipboard snippets for coordination even when cloud chat/apps are unreliable. +2. **Field operations / pop-up teams** + On construction sites, incident response setups, film sets, or lab environments, people can exchange photos, logs, and docs directly over a local hotspot without relying on external services. +3. **Classrooms, workshops, and local events** + Instructors and participants can quickly distribute materials and gather submissions device-to-device on venue Wi-Fi, reducing setup friction and avoiding account sign-ins. + ## Project Direction (Local Only) - Zap is intended to run on a local machine and local network. @@ -195,4 +208,4 @@ GitHub Actions runs `.github/workflows/ci.yml` on: The workflow installs dependencies and runs `npm run check` on Node 18 and Node 20. -For merge protection, set branch protection on `main` and require the CI status checks to pass before merging. +Passing CI status checks are required before merging. diff --git a/public/icon-192.svg b/public/icon-192.svg index 4f97a29..f7e1cfe 100644 --- a/public/icon-192.svg +++ b/public/icon-192.svg @@ -1,9 +1,13 @@ - - - - - - - - - \ No newline at end of file + + Zap icon + Minimal monoline Z mark. + + + + + + + + + + diff --git a/public/icon-512.svg b/public/icon-512.svg index aa8b4eb..4a52c90 100644 --- a/public/icon-512.svg +++ b/public/icon-512.svg @@ -1,9 +1,13 @@ - - - - - - - - - \ No newline at end of file + + Zap icon + Minimal monoline Z mark. + + + + + + + + + + diff --git a/public/zap-icon-alt-1.svg b/public/zap-icon-alt-1.svg new file mode 100644 index 0000000..8975eae --- /dev/null +++ b/public/zap-icon-alt-1.svg @@ -0,0 +1,23 @@ + + Zap icon alt 1 + Minimal beacon icon with soft rings and center pulse. + + + + + + + + + + + + + + + + + + + + diff --git a/public/zap-icon-alt-2.svg b/public/zap-icon-alt-2.svg new file mode 100644 index 0000000..afda866 --- /dev/null +++ b/public/zap-icon-alt-2.svg @@ -0,0 +1,25 @@ + + Zap icon alt 2 + Simple node-to-node transfer icon. + + + + + + + + + + + + + + + + + + + + + + diff --git a/public/zap-icon-alt-3.svg b/public/zap-icon-alt-3.svg new file mode 100644 index 0000000..295ba08 --- /dev/null +++ b/public/zap-icon-alt-3.svg @@ -0,0 +1,19 @@ + + Zap icon alt 3 + Monogram-style Z with forward motion arrow. + + + + + + + + + + + + + + + + diff --git a/public/zap-icon-alt-3a.svg b/public/zap-icon-alt-3a.svg new file mode 100644 index 0000000..6900d26 --- /dev/null +++ b/public/zap-icon-alt-3a.svg @@ -0,0 +1,13 @@ + + Zap icon alt 3A + Minimal monoline Z mark. + + + + + + + + + + diff --git a/public/zap-icon-alt-3b.svg b/public/zap-icon-alt-3b.svg new file mode 100644 index 0000000..17d26e0 --- /dev/null +++ b/public/zap-icon-alt-3b.svg @@ -0,0 +1,14 @@ + + Zap icon alt 3B + Minimal monoline Z with subtle endpoint pulse. + + + + + + + + + + + diff --git a/public/zap-icon-alt-3c.svg b/public/zap-icon-alt-3c.svg new file mode 100644 index 0000000..caf4a04 --- /dev/null +++ b/public/zap-icon-alt-3c.svg @@ -0,0 +1,15 @@ + + Zap icon alt 3C + Solid geometric lightning Z mark. + + + + + + + + + + + + diff --git a/public/zap-icon-readme.svg b/public/zap-icon-readme.svg new file mode 100644 index 0000000..34c3aa7 --- /dev/null +++ b/public/zap-icon-readme.svg @@ -0,0 +1,58 @@ + + Zap icon + Layered network beacon with bidirectional transfer arrows. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +