A fast, local-first "redirection engine" for !bang users with a few extra features ^-^

docs: update readme to be a bit less annoying

dunkirk.sh 247d99b6 e101f194

verified
+4 -58
+4 -58
README.md
··· 7 7 ## Quick Start 8 8 9 9 Add this URL as a custom search engine to your browser to use DuckDuckGo's bangs, but faster: 10 + 10 11 ``` 11 12 https://s.dunkirk.sh?q=%s 12 13 ``` ··· 41 42 - [x] Kagi bangs! We are able to grab the bangs from [kagisearch/bangs](https://github.com/kagisearch/bangs/) and Kagi is far more responsive than DuckDuckGo when it comes to updating their bangs. 42 43 43 44 I would love to add these but they don't seem possible / feasible at the moment: 45 + 44 46 - [ ] ~Search suggestions~ (as far as I can tell this essentially impossible to do natively with either firefox or chrome; please correct me if I'm wrong though. In this case I would very much love to be wrong) 45 47 - [x] ~Weekly bang checks to ensure that all bangs still work and excludes those that don't~ this ended up being unreliable because of cloudflare rate limiting and switching to kagi bangs helped a lot with this 46 48 47 - ## Fancy smancy technical graphs 😮 48 - 49 - The total size of the app is `717.4 KB` (one time download) 50 - 51 - ### Resource Breakdown 52 - 53 - ```mermaid 54 - graph TD 55 - subgraph Resources by Size 56 - A[index-B8HLUc3J.js<br/>contains all the ddg bangs<br/>482.5 KB] 57 - B[Font File<br/>25.1 KB] 58 - subgraph Audio Files 59 - C[Audio Files<br/>198.5 KB Total] 60 - end 61 - subgraph Small Assets 62 - D[SVGs & CSS<br/>~11 KB] 63 - end 64 - end 65 - ``` 66 - 67 - ### Network Performance 68 - 69 - ```mermaid 70 - gantt 71 - title Network Waterfall Chart 72 - dateFormat HH:mm:ss.SSS 73 - axisFormat %L 74 - 75 - section Initial HTML 76 - GET / (2.8 KB) :done, h1, 10:07:29.038, 208ms 77 - 78 - section JavaScript 79 - beacon.min.js :done, b1, 10:07:29.279, 0ms 80 - index-B8HLUc3J.js (482.5 KB) :done, j1, 10:07:29.286, 32ms 81 - registerSW.js (2.2 KB) :done, j2, 10:07:29.287, 60ms 82 - beacon.min.js (2nd) :done, b2, 10:07:29.383, 0ms 83 - 84 - section Styles 85 - Main CSS (3.8 KB) :done, c2, 10:07:29.287, 60ms 86 - Font File (25.1 KB) :done, f1, 10:07:29.379, 46ms 87 - 88 - section Assets 89 - gear.svg (2.5 KB) :done, s1, 10:07:29.494, 58ms 90 - clipboard.svg (2.4 KB) :done, s2, 10:07:29.495, 63ms 91 - search.svg (2.4 KB) :done, s3, 10:07:29.589, 32ms 92 - 93 - section Audio 94 - heavier-tick-sprite.mp3 (22.4 KB) :done, a1, 10:07:29.495, 33ms 95 - toggle-off.mp3 (34.3 KB) :done, a2, 10:07:29.495, 32ms 96 - toggle-on.mp3 (34.3 KB) :done, a3, 10:07:29.496, 46ms 97 - click.mp3 (34.3 KB) :done, a4, 10:07:29.497, 35ms 98 - double.mp3 (34.3 KB) :done, a5, 10:07:29.498, 44ms 99 - foot-switch.mp3 (34.3 KB):done, a6, 10:07:29.498, 38ms 100 - ``` 101 - 102 - 103 49 ## Screenshots 104 50 105 51 <details> 106 - <summary>Spoiler Alert: There is both a light and a dark mode 🤯</summary> 52 + <summary>Spoiler Alert: There is both a light and a dark mode 🤯 (shocking i know)</summary> 107 53 108 54 ### Light Mode 109 55 ··· 111 57 ![Light Mode with Search History](https://raw.githubusercontent.com/taciturnaxolotl/unduckified/main/.github/images/light-history.webp) 112 58 ![Light Mode 404](https://raw.githubusercontent.com/taciturnaxolotl/unduckified/main/.github/images/light-404.webp) 113 59 114 - ### Dark Mode 💪 60 + ### Dark Mode (the superior mode) 115 61 116 62 ![Dark Mode](https://raw.githubusercontent.com/taciturnaxolotl/unduckified/main/.github/images/dark.webp) 117 63 ![Dark Mode with Search History](https://raw.githubusercontent.com/taciturnaxolotl/unduckified/main/.github/images/dark-history.webp)