From 22b6a7b4b3aeb501a04e99a3cf8dd245b144fa83 Mon Sep 17 00:00:00 2001 From: Robert M1 <50460704+githubrobbi@users.noreply.github.com> Date: Sat, 4 Jul 2026 21:36:14 -0700 Subject: [PATCH] docs(crates): add a "Part of UFFS" callout atop uffs-text / uffs-time READMEs Both crates only linked back to UFFS at the bottom. Add a short, tasteful callout right under the badges so anyone discovering them on crates.io immediately sees the parent project (credibility for the crate, a little exposure for UFFS). Docs-only; no change to either crate's API or output. Co-Authored-By: Claude Opus 4.8 --- crates/uffs-text/README.md | 6 ++++++ crates/uffs-time/README.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/crates/uffs-text/README.md b/crates/uffs-text/README.md index b7af791b3..68a9b242b 100644 --- a/crates/uffs-text/README.md +++ b/crates/uffs-text/README.md @@ -7,6 +7,12 @@ [![License: MPL-2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](../../LICENSE) [![Repository](https://img.shields.io/badge/repo-skyllc--ai%2FUltraFastFileSearch-blue)](https://github.com/skyllc-ai/UltraFastFileSearch) +> **Part of [Ultra Fast File Search](https://github.com/skyllc-ai/UltraFastFileSearch).** +> UFFS is a Windows-first, high-performance file-search engine that reads the +> NTFS Master File Table directly. `uffs-text` is its case-folding component, +> published standalone because bit-exact NTFS filename comparison is useful +> well beyond UFFS. + NTFS performs every case-insensitive filename operation — directory lookup, attribute matching, indexed binary-tree comparisons — against its on-disk **`$UpCase`** table. That table is a 128 KB flat array diff --git a/crates/uffs-time/README.md b/crates/uffs-time/README.md index 85952b4b4..f5373f775 100644 --- a/crates/uffs-time/README.md +++ b/crates/uffs-time/README.md @@ -7,6 +7,12 @@ [![License: MPL-2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](../../LICENSE) [![Repository](https://img.shields.io/badge/repo-skyllc--ai%2FUltraFastFileSearch-blue)](https://github.com/skyllc-ai/UltraFastFileSearch) +> **Part of [Ultra Fast File Search](https://github.com/skyllc-ai/UltraFastFileSearch).** +> UFFS is a Windows-first, high-performance file-search engine that reads the +> NTFS Master File Table directly. `uffs-time` provides its FILETIME conversion +> primitives, published standalone because any tool decoding raw NTFS +> timestamps can reuse them. + Windows stores timestamps as **FILETIME**: a 64-bit signed count of 100-nanosecond ticks since `1601-01-01 00:00:00 UTC`. Every NTFS MFT record carries four of them (created / modified / MFT-modified /