Skip to content

Commit a7ccfad

Browse files
committed
Auto Update
1 parent a4fbf62 commit a7ccfad

1 file changed

Lines changed: 17 additions & 15 deletions

File tree

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Platform](https://img.shields.io/badge/Platform-Windows%2010+-lightgrey.svg)]()
77
[![JitPack](https://img.shields.io/badge/JitPack-ready-green.svg)](https://jitpack.io/#andrestubbe)
88

9-
**Scan and search millions of files in milliseconds with zero latency.**
9+
**Scan and search millions of files in milliseconds with zero latency.**
1010

1111
FastFileIndex is the high-performance file indexing engine for the FastJava ecosystem. It bypasses standard Java file IO
1212
to provide direct, native-accelerated indexing and search capabilities for massive directory trees.
@@ -130,18 +130,22 @@ Download the latest JARs directly to add them to your classpath:
130130

131131
---
132132

133-
## Platform Support
133+
## Documentation
134134

135-
| Platform | Status |
136-
|---------------------|-------------------|
137-
| Windows 10/11 (x64) | ✅ Fully Supported |
138-
| Linux | 🚧 Planned |
135+
* **[COMPILE.md](COMPILE.md)**: Full compilation guide (MSVC C++17 build chain + JNI Setup).
136+
* **[REFERENCE.md](REFERENCE.md)**: Full API descriptions, border configurations, and codepoint index.
137+
* **[PHILOSOPHIE.md](PHILOSOPHIE.md)**: The engineering rationale for zero-allocation performance.
138+
* **[ROADMAP.md](ROADMAP.md)**: Future milestones and planned features.
139139

140140
---
141141

142-
## Building from Source
142+
## Platform Support
143143

144-
For detailed instructions on compiling the C++ JNI code, see [COMPILE.md](COMPILE.md).
144+
| Platform | Status |
145+
|---------------|-------------------|
146+
| Windows 10/11 | ✅ Fully Supported |
147+
| Linux | 🚧 Planned |
148+
| macOS | 🚧 Planned |
145149

146150
---
147151

@@ -153,13 +157,11 @@ MIT License — See [LICENSE](LICENSE) file for details.
153157

154158
## Related Projects
155159

156-
- [FastCore](https://github.com/andrestubbe/FastCore) — Native Library Loader for Java
157-
- [FastFileSearch](https://github.com/andrestubbe/FastFileSearch) — Real-time fuzzy search engine
158-
- [FastThumb](https://github.com/andrestubbe/FastThumb) — Native Shell Image Engine
160+
- [FastFileIndex](https://github.com/andrestubbe/FastFileIndex) - Binary file indexing with mmap support
161+
- [FastFileSearch](https://github.com/andrestubbe/FastFileSearch) - Prefix Trie, N-Gram index, and Ranking engine
162+
- [FastFileWatch](https://github.com/andrestubbe/FastFileWatch) - USN Journal-based live file monitoring
163+
- [FastCore](https://github.com/andrestubbe/FastCore) - Unified JNI loader and platform abstraction
159164

160165
---
161-
**Made with ⚡ by Andre Stubbe**
162166

163-
<!--
164-
SEO Keywords: java, jni, indexing, file system, windows api, performance
165-
-->
167+
**Part of the FastJava Ecosystem***Making the JVM faster. Small package. Maximum speed. Zero bloat. 🚀📋*

0 commit comments

Comments
 (0)