fdidx/README.md

26 lines
927 B
Markdown

# fdidx - Full Disk indexer based on tantivy
Fdidx is a desktop search engine based on tantivy. It runs in background and regularly scans files for modifications.
When modifications occur, it will automatically attempt to extract text from the file.
It can connect to plugins via an IPC mechanism.
## Installation
You can build the service by running
```bash
cargo build --release
```
## Contributing
Pull requests are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
## License
This project is licensed under the [CC-BY-NC-SA 4.0](LICENSE.CC-NC.md) license and the [Hippocratic License 3.0](LICENSE.HL.md).
### Commercial Use
Notwithstanding the provisions in the CC-BY-NC-SA license, we offer commercial licenses to entities that follow the terms of the [Hippocratic License](LICENSE.HL.md).
[Please contact sales](mailto:lotte@chir.rs) for more information as well as pricing information.