From 080904675809fa1df0e50957e8df16a085c91811 Mon Sep 17 00:00:00 2001
From: Christian Cleberg <hello@cleberg.net>
Date: Sun, 2 Aug 2026 15:29:31 -0500
Subject: convert readme to nfo; relicense to 0bsd

---
 README.md | 106 --------------------------------------------------------------
 1 file changed, 106 deletions(-)
 delete mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
deleted file mode 100644
index 6384a1b..0000000
--- a/README.md
+++ /dev/null
@@ -1,106 +0,0 @@
-[![](https://deepwiki.com/badge.svg)](https://deepwiki.com/ccleberg/crumb)
-
-Crumb is a local-only browser history tracker. It consists of two parts:
-a WebExtension-based browser plugin and a local HTTP server. Crumb logs
-each visited web page to a plaintext file in Org-mode format.
-
-# Components
-
-- Browser extension (WebExtension API, JavaScript)
-- Local HTTP listener (Python + Flask)
-- Plaintext log file (~/.crumb/history.log)
-
-# Functionality
-
-Each time a page is loaded in the browser, the extension sends the page
-metadata to the local server. The server appends this data to a
-structured log file.
-
-Data captured per page:
-
-- Page title
-- URL
-- Timestamp (UTC)
-- Hostname
-- Path
-- Optional: query string, tab ID, window ID, favicon URL
-
-The log is formatted as an Org-mode file, with one top-level heading per
-visit and standard `:PROPERTIES:` metadata.
-
-# Requirements
-
-- Python 3.x
-- Flask
-- A Chromium-based or Firefox browser with extension developer mode
-  enabled
-
-# Usage
-
-1.  Start the local listener:
-
-    ``` shell
-    python3 -m venv venv
-    source ./venv/bin/activate
-    pip install -r requirements.txt
-    python server.py
-    ```
-
-2.  Load the extension into your browser:
-
-    - Enable Developer Mode
-    - Load the `crumb_extension/` directory
-
-3.  Browse the web. Entries will appear in `~/.crumb/history.org`
-
-4.  Search the log using:
-
-    ``` shell
-    python search.py <term>
-    ```
-
-# Example Log Entry
-
-``` org
-* Example Domain
-:PROPERTIES:
-:URL:       http://example.com
-:TIMESTAMP: 2025-06-04T20:31:01.123456
-:HOST:      example.com
-:PATH:      /
-:TAB:       143
-:WINDOW:    1
-:FAVICON:   https://example.com/favicon.ico
-:END:
-```
-
-# Preview Images
-
-Screenshots of Crumb in use.
-
-<figure>
-<img src="./screenshots/devtools.png" />
-<figcaption>Developer Console Output</figcaption>
-</figure>
-
-<figure>
-<img src="./screenshots/history.png" />
-<figcaption>Org-Mode History Log</figcaption>
-</figure>
-
-<figure>
-<img src="./screenshots/search.png" />
-<figcaption>Search Utility in Terminal</figcaption>
-</figure>
-
-# Limitations
-
-- Browser extensions cannot write files directly; communication requires
-  the local server.
-- History is stored in plaintext and is not encrypted. You can bolt-on a
-  third-party encryption tool, if required.
-- Data is stored locally and is never transmitted externally.
-
-# License
-
-GPL 3.0 License. See LICENSE file.
-- 
cgit v1.2.3