docs: add about page and update README with Forgejo repository links

This commit is contained in:
Ben Miller 2026-10-06 15:24:06 -05:00
parent 716ae7e3b2
commit 960f9a8968
2 changed files with 53 additions and 0 deletions

View file

@ -1,7 +1,11 @@
# SpotNotes # SpotNotes
[![Source on Forgejo](https://img.shields.io/badge/Source-Forgejo-orange.svg)](https://forgejo.benjimanmiller.com/ben/spotnotes.app)
SpotNotes is a privacy-first, location-based note-taking web application. It allows users to drop notes on an interactive map, organize them into notepads, and share them publicly or securely with specific users using zero-knowledge end-to-end encryption. SpotNotes is a privacy-first, location-based note-taking web application. It allows users to drop notes on an interactive map, organize them into notepads, and share them publicly or securely with specific users using zero-knowledge end-to-end encryption.
**Repository:** [https://forgejo.benjimanmiller.com/ben/spotnotes.app](https://forgejo.benjimanmiller.com/ben/spotnotes.app)
--- ---
## 🔒 Encryption-First Architecture (Zero-Knowledge E2EE) ## 🔒 Encryption-First Architecture (Zero-Knowledge E2EE)

View file

@ -62,6 +62,50 @@
<hr style="margin: 30px 0; border: 0; border-top: 1px solid #eee;"> <hr style="margin: 30px 0; border: 0; border-top: 1px solid #eee;">
<!-- Open Source & Don't Trust, Verify Section -->
<div style="background: linear-gradient(135deg, #f8fafc 0%, #f1f5f9 100%); border: 1px solid #cbd5e1; border-radius: 12px; padding: 24px; margin-bottom: 30px;">
<div style="display: flex; align-items: center; gap: 10px; margin-bottom: 12px;">
<span style="font-size: 1.6rem;">🛠️</span>
<h2 style="margin: 0; font-size: 1.35rem; color: #0f172a;">Don't Trust, Verify — 100% Open Source</h2>
</div>
<p style="line-height: 1.6; color: #334155; margin-bottom: 16px;">
True privacy shouldn't be based on marketing claims or blind faith. SpotNotes is built with total transparency:
<strong>don't trust our word for it — verify the implementation yourself, audit our zero-knowledge cryptographic routines, or run your own instance.</strong>
</p>
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(240px, 1fr)); gap: 16px; margin: 20px 0;">
<div style="background: white; border: 1px solid #e2e8f0; border-radius: 8px; padding: 14px;">
<h4 style="margin: 0 0 6px 0; color: #0284c7; font-size: 0.95rem;">🔍 Audit the Cryptography</h4>
<p style="margin: 0; font-size: 0.85rem; color: #64748b; line-height: 1.4;">
Inspect every single line of client-side Web Crypto (AES-256-GCM, RSA-OAEP, PBKDF2) to confirm private notes never leave your browser unencrypted.
</p>
</div>
<div style="background: white; border: 1px solid #e2e8f0; border-radius: 8px; padding: 14px;">
<h4 style="margin: 0 0 6px 0; color: #0284c7; font-size: 0.95rem;">🚀 Self-Host Your Own Server</h4>
<p style="margin: 0; font-size: 0.85rem; color: #64748b; line-height: 1.4;">
Deploy SpotNotes on your own hardware or VPS in minutes with zero lock-in. Full data sovereignty and control over your deployment.
</p>
</div>
<div style="background: white; border: 1px solid #e2e8f0; border-radius: 8px; padding: 14px;">
<h4 style="margin: 0 0 6px 0; color: #0284c7; font-size: 0.95rem;">🤝 Open Collaboration</h4>
<p style="margin: 0; font-size: 0.85rem; color: #64748b; line-height: 1.4;">
Follow ongoing development, submit pull requests, open issues, and join the community on our self-hosted Forgejo instance.
</p>
</div>
</div>
<div style="margin-top: 18px; display: flex; flex-wrap: wrap; align-items: center; gap: 12px;">
<a href="https://forgejo.benjimanmiller.com/ben/spotnotes.app" target="_blank" rel="noopener noreferrer" class="btn btn-primary" style="text-decoration: none; display: inline-flex; align-items: center; gap: 8px; width: auto; padding: 10px 22px; font-weight: 600;">
<span>📂 View Source on Forgejo</span>
<span>&nearr;</span>
</a>
<span style="font-size: 0.85rem; color: #64748b; font-family: monospace;">forgejo.benjimanmiller.com/ben/spotnotes.app</span>
</div>
</div>
<hr style="margin: 30px 0; border: 0; border-top: 1px solid #eee;">
<h2 style="margin-bottom: 1rem;">Frequently Asked Questions</h2> <h2 style="margin-bottom: 1rem;">Frequently Asked Questions</h2>
<div style="margin-bottom: 20px;"> <div style="margin-bottom: 20px;">
@ -69,6 +113,11 @@
<p style="color: #555;">No. Private notes are encrypted client-side in your browser using the Web Crypto API before being transmitted. The server only stores ciphertext.</p> <p style="color: #555;">No. Private notes are encrypted client-side in your browser using the Web Crypto API before being transmitted. The server only stores ciphertext.</p>
</div> </div>
<div style="margin-bottom: 20px;">
<h4 style="margin-bottom: 5px;">Where can I find the source code or self-host SpotNotes?</h4>
<p style="color: #555;">SpotNotes is 100% open source. You can explore the codebase, review the cryptography, or clone the repository to run your own server at <a href="https://forgejo.benjimanmiller.com/ben/spotnotes.app" target="_blank" rel="noopener noreferrer" style="color: #0284c7; text-decoration: underline;">forgejo.benjimanmiller.com/ben/spotnotes.app</a>.</p>
</div>
<div style="margin-bottom: 20px;"> <div style="margin-bottom: 20px;">
<h4 style="margin-bottom: 5px;">How does sharing private notepads work?</h4> <h4 style="margin-bottom: 5px;">How does sharing private notepads work?</h4>
<p style="color: #555;">When you add a collaborator, your browser encrypts the notepad key using the collaborator's public key. Only their private key can unlock it.</p> <p style="color: #555;">When you add a collaborator, your browser encrypts the notepad key using the collaborator's public key. Only their private key can unlock it.</p>