Auto Update

Author: andrestubbe

README.md

@@ -1,33 +1,38 @@
-# FastFileIndex — Ultra-Fast Native File Indexing for Java
+# FastFileIndex v0.1.0 [ALPHA] — Ultra-Fast Native File Indexing for Java
+
+[![Status](https://img.shields.io/badge/status-v0.1.0-brightgreen.svg)](https://github.com/andrestubbe/FastFileIndex/releases/tag/v0.1.0)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![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)]()
+[![JitPack](https://img.shields.io/badge/JitPack-ready-green.svg)](https://jitpack.io/#andrestubbe)
 
 **Scan and search millions of files in milliseconds with zero latency.**
 
-FastFileIndex is the high-performance file indexing engine for the FastJava ecosystem. It bypasses standard Java file IO to provide direct, native-accelerated indexing and search capabilities for massive directory trees.
+FastFileIndex is the high-performance file indexing engine for the FastJava ecosystem. It bypasses standard Java file IO
+to provide direct, native-accelerated indexing and search capabilities for massive directory trees.
+
+[![FastFileIndex Showcase](docs/screenshot.png)](https://www.youtube.com/watch?v=BZsqQl7WqWk)
 
 ```java
 // Quick Start — Indexing a directory
+
 import fastfileindex.FastFileIndex;
 
 public class Demo {
     public static void main(String[] args) {
-        String[] roots = { "C:\\" };
+        String[] roots = {"C:\\"};
         FastFileIndex.build(roots);
-        
+
         long count = FastFileIndex.getEntryCount();
         System.out.println("Indexed " + count + " files!");
     }
 }
 ```
 
-[![Status](https://img.shields.io/badge/status-v0.1.0-brightgreen.svg)](https://github.com/andrestubbe/FastFileIndex/releases/tag/v0.1.0)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![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)]()
-[![JitPack](https://img.shields.io/badge/JitPack-ready-green.svg)](https://jitpack.io/#andrestubbe)
-
 ---
 
 ## Table of Contents
+
 - [Key Features](#key-features)
 - [Performance](#performance)
 - [Installation](#installation)
@@ -52,18 +57,20 @@ public class Demo {
 
 FastFileIndex out-performs standard Java NIO indexing by utilizing Windows-specific kernel-level optimizations.
 
-| Operation | FastFileIndex | Java NIO | Speedup |
-|-----------|---------|---------------|---------|
-| Scan 1M Files | 280 ms | 4500 ms | **16x** |
+| Operation     | FastFileIndex | Java NIO | Speedup |
+|---------------|---------------|----------|---------|
+| Scan 1M Files | 280 ms        | 4500 ms  | **16x** |
 
 ---
 
 ## Installation
 
 ### Option 1: Maven (Recommended)
+
 Add the JitPack repository and the dependencies to your `pom.xml`:
 
 ```xml
+
 <repositories>
     <repository>
         <id>jitpack.io</id>
@@ -72,23 +79,24 @@ Add the JitPack repository and the dependencies to your `pom.xml`:
 </repositories>
 
 <dependencies>
-    <!-- FastFileIndex Library -->
-    <dependency>
-        <groupId>com.github.andrestubbe</groupId>
-        <artifactId>fastfileindex</artifactId>
-        <version>v0.1.0</version>
-    </dependency>
-
-    <!-- FastCore (Required Native Loader) -->
-    <dependency>
-        <groupId>com.github.andrestubbe</groupId>
-        <artifactId>fastcore</artifactId>
-        <version>v0.1.0</version>
-    </dependency>
+<!-- FastFileIndex Library -->
+<dependency>
+    <groupId>com.github.andrestubbe</groupId>
+    <artifactId>fastfileindex</artifactId>
+    <version>v0.1.0</version>
+</dependency>
+
+<!-- FastCore (Required Native Loader) -->
+<dependency>
+    <groupId>com.github.andrestubbe</groupId>
+    <artifactId>fastcore</artifactId>
+    <version>v0.1.0</version>
+</dependency>
 </dependencies>
 ```
 
 ### Option 2: Gradle (via JitPack)
+
 ```groovy
 repositories {
     maven { url 'https://jitpack.io' }
@@ -101,30 +109,33 @@ dependencies {
 ```
 
 ### Option 3: Direct Download (No Build Tool)
+
 Download the latest JARs directly to add them to your classpath:
 
-1. 📦 **[fastfileindex-v0.1.0.jar](https://github.com/andrestubbe/FastFileIndex/releases/download/v0.1.0/fastfileindex-v0.1.0.jar)** (The Core Library)
-2. ⚙️ **[fastcore-v0.1.0.jar](https://github.com/andrestubbe/FastCore/releases/download/v0.1.0/fastcore-v0.1.0.jar)** (The Mandatory Native Loader)
+1. 📦 *
+   *[fastfileindex-v0.1.0.jar](https://github.com/andrestubbe/FastFileIndex/releases/download/v0.1.0/fastfileindex-v0.1.0.jar)
+   ** (The Core Library)
+2. ⚙️ **[fastcore-v0.1.0.jar](https://github.com/andrestubbe/FastCore/releases/download/v0.1.0/fastcore-v0.1.0.jar)** (
+   The Mandatory Native Loader)
 
 > [!IMPORTANT]
 > All JARs must be in your classpath for the native JNI calls to function correctly.
 
-
 ## API Reference
 
-| Method | Description |
-|--------|-------------|
+| Method                       | Description                                       |
+|------------------------------|---------------------------------------------------|
 | `void build(String[] roots)` | Scans and indexes the specified root directories. |
-| `long getEntryCount()` | Returns the total number of indexed files. |
+| `long getEntryCount()`       | Returns the total number of indexed files.        |
 
 ---
 
 ## Platform Support
 
-| Platform | Status |
-|----------|--------|
+| Platform            | Status            |
+|---------------------|-------------------|
 | Windows 10/11 (x64) | ✅ Fully Supported |
-| Linux | 🚧 Planned |
+| Linux               | 🚧 Planned        |
 
 ---
 
@@ -135,11 +146,13 @@ For detailed instructions on compiling the C++ JNI code, see [COMPILE.md](COMPIL
 ---
 
 ## License
+
 MIT License — See [LICENSE](LICENSE) file for details.
 
 ---
 
 ## Related Projects
+
 - [FastCore](https://github.com/andrestubbe/FastCore) — Native Library Loader for Java
 - [FastFileSearch](https://github.com/andrestubbe/FastFileSearch) — Real-time fuzzy search engine
 - [FastThumb](https://github.com/andrestubbe/FastThumb) — Native Shell Image Engine