diff options
Diffstat (limited to 'vendor/elasticlunr-rs/README.md')
| -rw-r--r-- | vendor/elasticlunr-rs/README.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/vendor/elasticlunr-rs/README.md b/vendor/elasticlunr-rs/README.md new file mode 100644 index 000000000..bd7d534e9 --- /dev/null +++ b/vendor/elasticlunr-rs/README.md @@ -0,0 +1,58 @@ +# elasticlunr-rs + + +[](https://docs.rs/elasticlunr-rs) +[](https://crates.io/crates/elasticlunr-rs) + + +A partial port of [elasticlunr.js][eljs] to Rust. Intended to be used for +generating compatible search indices. + +## Example + +```Rust +use std::fs::File; +use std::io::Write; +use elasticlunr::Index; + +let mut index = Index::new(&["title", "body"]); +index.add_doc("1", &["This is a title", "This is body text!"]); +// Add more documents... +let mut file = File::create("out.json").unwrap(); +file.write_all(index.to_json_pretty().as_bytes()); +``` + +## Minimum Supported Rust Version + +1.54.0 + +## Languages + +This library includes optional support for non-English languages, see the features in `Cargo.toml`. Like in the JavaScript +version, the language support is designed to be compatible with the [lunr-languages plugins][lunr-languages]. Some +languages use a modified version, which is included in the `js` directory of the repository. + +## License + +This repository is offered under the terms of the + +- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) + +at your option. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +Includes code ported from [elasticlunr.js][eljs] Copyright (C) 2017 by Wei Song, +used under license. See LICENSE-JS for details. + +Includes stop word lists ported from [stopwords-filter][swft] Copyright (C) 2012 +David J. Brenes, used under license. See LICENSE-WORDS for details. + +Bundled javascript code in the repository (not included in the cargo package) may have other licenses. + +[lunr-languages]: https://github.com/MihaiValentin/lunr-languages +[eljs]: https://github.com/weixsong/elasticlunr.js +[swft]: https://github.com/brenes/stopwords-filter
\ No newline at end of file |