From 64e420fee248949a55d6e9b91e70c29f64317bec Mon Sep 17 00:00:00 2001 From: Danny Morabito Date: Wed, 4 Mar 2026 08:59:04 -0300 Subject: [PATCH 1/2] docs: add marmot pixel art illustrations to each README section --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index ab53560..bb82b68 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,14 @@ *A Nostr Profile Auditor* +![Dr. Marmot](https://blossom.primal.net/953759719f553f29716fd17bf4d25a9237f6ef5677d5f49ba441d6f93215ad65.png) + Paste an npub. One of our doctors will examine your Nostr identity across every relay you publish to, checking sync, verifying NIP-05, and scanning for Marmot Protocol compliance. You'll get a full diagnosis card with findings and a prescription. ## The Examination +![The Examination](https://blossom.primal.net/07d485d6da2ac3aa080676e95d92332e3fa03a29a1f48dd8516f6ebca1f49f59.png) + ### Relay Health - Discovers your relay list from kind 3 / 10002 / 10050 / 10051 events @@ -32,6 +36,8 @@ At the end, the doctor charts a diagnosis card: pass/warn/error counts, detailed ## Running Locally +![Running Locally](https://blossom.primal.net/70d3f10880b8c90865d74529249c1ffc6f888f354d1b41aff21a8d6037bd63cd.png) + No build step. Zero npm dependencies. Just serve the static files — a local server is needed because the app uses ES modules and loads nostr-tools from a CDN. ```bash @@ -49,10 +55,14 @@ npx http-server ## Deploying +![Deploying](https://blossom.primal.net/7c1741470a6dfba1a404644ad4b037da6d79a7c9cd14bc9a3d5f1a20d66c2d87.png) + Drop the files on any static host (GitHub Pages, Netlify, Vercel, Cloudflare Pages). No configuration needed. ## How It Works +![How It Works](https://blossom.primal.net/c5886cda40456b6a6c9e520ade529a79c443d1e00d0118c830479e67889724aa.png) + 1. Paste an npub or sign in with a NIP-07 browser extension 2. The doctor connects to bootstrap relays and discovers your relay list 3. Every discovered relay is queried for your profile, contacts, and relay lists @@ -62,6 +72,8 @@ Drop the files on any static host (GitHub Pages, Netlify, Vercel, Cloudflare Pag ## Project Structure +![Project Structure](https://blossom.primal.net/35df576bc16788c3d78bbeb559524ad0455fa2cfa9ca6f3e3b6ffd45d8cbf6c9.png) + ```text dr.marmot/ ├── index.html # Entry point @@ -95,6 +107,8 @@ dr.marmot/ ## Tech Stack +![Tech Stack](https://blossom.primal.net/286bfd6edd26194dfb3f94892d455978ac73630a661afc7d2d85e3a2e796c550.png) + - Vanilla JavaScript — ES6 modules, no framework, no build step - Web Audio API for the retro beeps - [nostr-tools](https://github.com/nbd-wtf/nostr-tools) via ESM CDN @@ -102,5 +116,7 @@ dr.marmot/ ## Related +![Related](https://blossom.primal.net/f0b3208defef4ecfd313d7fab5275bda071cb8d7a336500e62e6a13e7e1ed469.png) + - [Nostr Protocol](https://github.com/nostr-protocol/nostr) — the protocol being audited - [Marmot Protocol](https://github.com/marmot-protocol/marmot) — MLS-based encrypted messaging for Nostr From 0015016516a0f83c1e51e9827ea17a2ddddcd83d Mon Sep 17 00:00:00 2001 From: Danny Morabito Date: Wed, 4 Mar 2026 09:21:50 -0300 Subject: [PATCH 2/2] add missing readme sections --- LICENSE | 21 +++++++++++++++++++++ README.md | 21 +++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a34502d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Marmot Protocol + +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. diff --git a/README.md b/README.md index bb82b68..88aa877 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,27 @@ dr.marmot/ - [nostr-tools](https://github.com/nbd-wtf/nostr-tools) via ESM CDN - [Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P) pixel font +## Browser Requirements + +![Browser Requirements](https://blossom.primal.net/d433dc35b37f30d5f07cf166d97e135e856f28e672ec3e753bfbe5567f7c93cd.png) + +The app uses native ES modules and the Web Audio API — no polyfills, no transpilation. Any modern browser works: + +| Browser | Minimum Version | +|---------|----------------| +| Chrome | 61+ | +| Firefox | 60+ | +| Safari | 11+ | +| Edge | 16+ | + +Internet Explorer is not supported. + +## License + +![License](https://blossom.primal.net/3b46682ddbd07e5b077c441f3cc7558e7a550e88e281ad467a1f44219893cbe1.png) + +MIT — see [LICENSE](LICENSE). + ## Related ![Related](https://blossom.primal.net/f0b3208defef4ecfd313d7fab5275bda071cb8d7a336500e62e6a13e7e1ed469.png)