Skip to content

Commit 34fc124

Browse files
committed
readme: Add more info
1 parent 4168f14 commit 34fc124

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ authors = ["Tony Solomonik @ [email protected]"]
66
description = "A search engine on object storage."
77
repository = "https://github.com/tontinton/toshokan"
88
homepage = "https://github.com/tontinton/toshokan"
9+
readme = "./README.md"
910
license = "Apache-2.0 OR MIT"
1011

1112
[profile.release]

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
## Introduction
2+
3+
`toshokan` is a search engine (think Elasticsearch, Splunk), but storing the data on object storage, most similar to <a href="https://github.com/quickwit-oss/quickwit">Quickwit</a>.
4+
5+
It uses:
6+
* <a href="https://github.com/quickwit-oss/tantivy">tantivy</a> - for building and searching the inverted index data structure.
7+
* <a href="https://github.com/apache/opendal">Apache OpenDAL</a> - for an abstraction over object storages.
8+
9+
<img style="border-radius: 10px; border: 1px solid white" src="./architecture.svg">
10+
11+
## How to use
12+
113
```sh
214
toshokan create example_config.yaml
315

@@ -22,5 +34,8 @@ toshokan search test "tenant_id:[60 TO 65} AND severity_text:INFO" --limit 1 | j
2234
# "timestamp": "2016-04-13T06:46:54Z"
2335
# }
2436

37+
# Merge index files for faster searching.
38+
toshokan merge test
39+
2540
toshokan drop test
2641
```

architecture.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)