diff --git a/Cargo.toml b/Cargo.toml index d40d127..1a535c4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,6 +6,7 @@ authors = ["Tony Solomonik @ tony.solomonik@gmail.com"] description = "A search engine on object storage." repository = "https://github.com/tontinton/toshokan" homepage = "https://github.com/tontinton/toshokan" +readme = "./README.md" license = "Apache-2.0 OR MIT" [profile.release] diff --git a/README.md b/README.md index 980e86c..19cca7a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ +## Introduction + +`toshokan` is a search engine (think Elasticsearch, Splunk), but storing the data on object storage, most similar to Quickwit. + +It uses: +* tantivy - for building and searching the inverted index data structure. +* Apache OpenDAL - for an abstraction over object storages. + +