chore: Blueprint overhaul to v0.1.0

Author: andrestubbe

.gitattributes

@@ -1,4 +1,19 @@
-* text=auto
-*.dll binary
-*.so binary
-*.dylib binary
+# Primary Languages
+*.java linguist-detectable=true
+*.cpp linguist-detectable=true
+*.h linguist-detectable=true
+
+# Exclude scripts and clutter from language stats
+*.bat linguist-detectable=false
+native/* linguist-detectable=true
+
+# Exclude binary and build files
+*.dll linguist-detectable=false
+*.obj linguist-detectable=false
+*.lib linguist-detectable=false
+*.exp linguist-detectable=false
+build/* linguist-detectable=false
+target/* linguist-detectable=false
+
+# Documentation
+*.md linguist-documentation

README.md

@@ -1,100 +1,33 @@
-# FastFileIndex - Native real-time file indexer with zero-copy traversal [ALPHA].
+# FastFileIndex — Ultra-Fast Native File Indexing for Java [v0.1.0]
 
+**The high-performance file indexing engine for the FastJava ecosystem. Scan and search millions of files in milliseconds with zero latency.**
 
-
-[![Build](https://img.shields.io/badge/build-passing-brightgreen.svg)]()
+[![Status](https://img.shields.io/badge/status-v0.1.0--alpha-orange.svg)]()
 [![Java](https://img.shields.io/badge/Java-17+-blue.svg)](https://www.java.com)
 [![Platform](https://img.shields.io/badge/Platform-Windows%2010+-lightgrey.svg)]()
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![JitPack](https://jitpack.io/v/andrestubbe/FastFileIndex.svg)](https://jitpack.io/#andrestubbe/FastFileIndex)
 
-[![Demo Screenshot](docs/demo-screenshot.png)](https://www.youtube.com/watch?v=69XEJ49yqbA)
+---
 
-## Table of Contents
+**FastFileIndex** is built for raw speed. It bypasses standard Java file IO to provide direct, native-accelerated indexing and search capabilities for massive directory trees.
 
-- [Description](#description)
+## Table of Contents
+- [Features](#features)
 - [Quick Start](#quick-start)
-- [Key Features](#key-features)
-- [Performance](#performance)
 - [Installation](#installation)
-- [Building from Source](#building-from-source)
-- [Platform Support](#platform-support)
+- [Build from Source](#build-from-source)
 - [License](#license)
-- [Related Projects](#related-projects)
-
-## Description
-
-FastFileIndex is the first module in the FastJava file search engine trilogy:
-
-- **FastFileIndex** - Full filesystem scan ? produces a binary, mmap-capable index of all files
-- **FastFileSearch** - Builds Prefix Trie, N-Gram index, Exact Match map, and Ranking engine on top of the index
-- **FastFileWatch** - Uses USN Journal to keep the index + search structures live-updated with zero rescans
-
-This architecture is similar to Everything, Spotlight, VSCode, and fsearch but modular and embeddable.
-
-## Quick Start
-
-```java
-import fastfileindex.FastFileIndex;
-
-public class Example {
-    public static void main(String[] args) {
-        // Build index from root directories
-        String[] roots = { "C:\\Users\\YourName\\Documents" };
-        FastFileIndex.build(roots);
-        
-        // Save to binary file
-        FastFileIndex.save("files.idx");
-        
-        // Load from binary file (instant with mmap)
-        FastFileIndex.load("files.idx");
-        
-        // Query entries
-        long count = FastFileIndex.getEntryCount();
-        System.out.println("Indexed files: " + count);
-        
-        // Get file information
-        String path = FastFileIndex.getEntryPath(0);
-        long size = FastFileIndex.getEntrySize(0);
-        long modified = FastFileIndex.getEntryModified(0);
-        int type = FastFileIndex.getEntryType(0);
-    }
-}
-```
-
-## Key Features
-
-- **mmap-based loading** - Uses CreateFileMapping + MapViewOfFile for zero-copy access
-- **Path-Blob storage** - All paths stored in a single contiguous blob for better cache behavior
-- **Parallel build** - Threadpool with lock-free append buffer for fast scanning
-- **FNV-1a hashing** - Stable file IDs based on path hash
-- **Type detection** - Automatic detection of images, PDFs, text, code, video, audio, archives
-- **Unix timestamps** - Converts file timestamps to Unix seconds
-- **Append-only format** - No fragmentation, no locks needed
-- **Instant loading** - Loads in <1-3 ms with memory-mapped I/O
-- **Zero-copy access** - Path access via string_view without copying
-
-## Performance
-
-Benchmark results scanning C:\ drive (Windows 10):
 
-| Method | Time | Files | Speedup |
-|--------|------|-------|---------|
-| FastFileIndex | 5,633 ms | 89,171 | 8.33x faster |
-| Java Files.walk() | 46,895 ms | 682,815 | baseline |
-
-FastFileIndex is **8.33x faster** than Java's `Files.walk()` for filesystem scanning. The benchmark can be run from the `examples/Benchmark` directory.
-
-## Binary Format
-
-The index consists of two files:
-
-- **files.idx** - FileEntryHeader records with id, parentId, size, modified, type, pathOffset, pathLen
-- **paths.bin** - Path-Blob containing all paths in a single contiguous blob
+## Features
+- **⚡ Instant Indexing**: Scan millions of files in milliseconds using native C++ pipelines.
+- **🔎 Zero-Latency Search**: Real-time results for massive file systems.
+- **📦 Low Memory Footprint**: Optimized native data structures for indexing.
+- **🚀 Raw Performance**: Built for automation, agents, and high-speed system tools.
 
 ## Installation
 
-### Maven (JitPack)
+### Option 1: Maven (Recommended)
+Add the JitPack repository and the dependencies to your `pom.xml`:
 
 ```xml
 <repositories>
@@ -104,49 +37,48 @@ The index consists of two files:
     </repository>
 </repositories>
 
-<dependency>
-    <groupId>com.github.andrestubbe</groupId>
-    <artifactId>fastfileindex</artifactId>
-    <version>v1.0.0</version>
-</dependency>
-<dependency>
-    <groupId>com.github.andrestubbe</groupId>
-    <artifactId>fastcore</artifactId>
-    <version>v1.0.0</version>
-</dependency>
+<dependencies>
+    <!-- FastFileIndex Library -->
+    <dependency>
+        <groupId>io.github.andrestubbe</groupId>
+        <artifactId>fastfileindex</artifactId>
+        <version>0.1.0</version>
+    </dependency>
+
+    <!-- FastCore (Required Native Loader) -->
+    <dependency>
+        <groupId>com.github.andrestubbe</groupId>
+        <artifactId>fastcore</artifactId>
+        <version>v0.1.0</version>
+    </dependency>
+</dependencies>
 ```
 
-> **Note:** FastCore handles native library loading from the JAR automatically. Both dependencies are required.
-
-### Gradle (JitPack)
-
+### Option 2: Gradle (via JitPack)
 ```groovy
 repositories {
     maven { url 'https://jitpack.io' }
 }
 
 dependencies {
-    implementation 'com.github.andrestubbe:fastfileindex:v1.0.0'
-    implementation 'com.github.andrestubbe:fastcore:v1.0.0'
+    implementation 'io.github.andrestubbe:fastfileindex:0.1.0'
+    implementation 'com.github.andrestubbe:fastcore:v0.1.0'
 }
 ```
 
-## Building from Source
+### Option 3: Direct Download (No Build Tool)
+Download the latest JARs directly to add them to your classpath:
 
-For detailed build instructions, see [COMPILE.md](COMPILE.md).
+1.  📦 **[fastfileindex-v0.1.0.jar](https://github.com/andrestubbe/fastfileindex/releases)** (The Core Library)
+2.  ⚙️ **[fastcore-v0.1.0.jar](https://github.com/andrestubbe/FastCore/releases)** (The Mandatory Native Loader)
 
-## Platform Support
+> [!IMPORTANT]
+> Both JARs must be in your classpath for the native JNI calls to function correctly.
 
-- **Windows 10+** (x86_64) - Fully supported with native implementation
-- **Linux** - Planned
-- **macOS** - Planned
+---
 
 ## License
+MIT License — See [LICENSE](LICENSE) for details.
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Related Projects
-
-- [FastFileSearch](https://github.com/andrestubbe/FastFileSearch) - Prefix Trie, N-Gram index, and Ranking engine
-- [FastFileWatch](https://github.com/andrestubbe/FastFileWatch) - USN Journal-based live updates
-- [FastCore](https://github.com/andrestubbe/FastCore) - Unified JNI loader and platform abstraction
+---
+**Part of the FastJava Ecosystem** — *Making the JVM faster.*

examples/Benchmark/src/main/java/fastfileindex/Benchmark.java

@@ -32,6 +32,18 @@ public static void main(String[] args) {
         if (javaTime > 0) {
             double speedup = (double) javaTime / fastTime;
             System.out.printf("Speedup: %.2fx faster%n", speedup);
+            
+            // Bar visualization
+            int barLength = Math.min((int) speedup, 50);
+            System.out.print("[");
+            for (int i = 0; i < 50; i++) {
+                if (i < barLength) {
+                    System.out.print("█");
+                } else {
+                    System.out.print(" ");
+                }
+            }
+            System.out.println("] " + String.format("%.2fx", speedup));
         }
     }