From 6e9ce68921c78cfea6617cca52f2a901abd16a17 Mon Sep 17 00:00:00 2001 From: Daniele De Dominicis <37807398+Danielededo@users.noreply.github.com> Date: Sun, 11 Oct 2026 09:52:50 +0200 Subject: [PATCH] docs: add the logo, badges, screenshots and links to the README --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 52 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a890018..3ba737b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,32 @@ -# spectral +

+ +

+ +

Spectral

+ +

+ See what runs behind any website: CDN, hosting, tech stack, network owner, + DNS and email setup, with the evidence for each. +

+ +

+ CI + Latest release + MIT License +

+ +

+ Install · + Privacy policy · + Changelog · + Report a problem +

+ +

+ Site page: edge, hosting and tech stack of wordpress.org + Network page: IP addresses and network owner + Email page: DNS provider, mail servers and policies +

A browser extension that shows what runs behind the site in your current tab: the CDN and hosting in front of it, the frameworks and libraries it is built @@ -6,7 +34,8 @@ with, who owns the IP network, which provider serves its DNS and email, and which SaaS the domain has verified ownership with. Each finding comes with the header, DNS record or page element that proves it. -Status: early development, not yet published on any store. +Status: early development. Submitted to Microsoft Edge Add-ons and in review; +not yet on the Chrome Web Store or Firefox Add-ons. ## Features @@ -34,21 +63,28 @@ left and right arrow keys: ## Installation +Each [release](https://github.com/danielededo/spectral/releases/latest) +carries two packages: `spectral--chromium.zip` for Chrome and Edge, +and `spectral--firefox.zip` for Firefox. Extract the Chromium one and +load the folder as described below; Firefox loads the zip directly as a +temporary add-on. + +To build from source instead: + ``` npm ci npm run build ``` The build writes `dist/` for Chromium browsers and Safari, and -`dist-firefox/` for Firefox; they differ only in `manifest.json`. Packaged -builds of each release are attached to the -[GitHub Releases](https://github.com/danielededo/spectral/releases). +`dist-firefox/` for Firefox; they differ only in `manifest.json`. Chrome and Edge: open `chrome://extensions` (or `edge://extensions`), enable -Developer mode, choose Load unpacked and select `dist/`. +Developer mode, choose Load unpacked and select `dist/` (or the extracted +release folder). Firefox (140 or later): open `about:debugging#/runtime/this-firefox`, choose -Load Temporary Add-on and select `dist-firefox/manifest.json`, or run +Load Temporary Add-on and select `dist-firefox/manifest.json` (or the release zip), or run `npm run firefox:run`. Firefox treats host permissions as optional, so grant "Access your data for all websites" from the extension's permissions page. @@ -118,6 +154,15 @@ Fingerprints live in `src/infrastructure/detect.ts` and tests; see [AGENTS.md](AGENTS.md) for the architecture and conventions, and [CONTRIBUTING.md](CONTRIBUTING.md) for the workflow. +More documents: + +- [docs/STORE-LISTING.md](docs/STORE-LISTING.md): store texts, permission + justifications, images and the release steps. +- [docs/adr/](docs/adr/README.md): architecture decisions, such as why there + is no backend. +- [SECURITY.md](SECURITY.md): how to report a vulnerability privately. +- [CHANGELOG.md](CHANGELOG.md): what changed in each version. + ## Structure ```