Skip to content

Commit 50f415a

Browse files
committed
Update README.md
1 parent b1ce491 commit 50f415a

1 file changed

Lines changed: 8 additions & 14 deletions

File tree

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
# 📄 DocSense: A Simple Document Search Engine
1+
# DocSense: A Simple Document Search Engine
22

33
DocSense is a lightweight, search engine built in Rust. It is designed to index and search into a large corpus of XML/XHTML/PDF/TXT/MD documents using TF-IDF or BM25 ranking. It also serves a local web interface for querying.
44

5-
---
6-
75
## Features
86

97
- Recursive document indexing
@@ -12,7 +10,6 @@ DocSense is a lightweight, search engine built in Rust. It is designed to index
1210
- Persistent JSON index storage
1311
- Local HTTP web interface
1412

15-
---
1613

1714
## Getting Started
1815

@@ -22,31 +19,30 @@ DocSense is a lightweight, search engine built in Rust. It is designed to index
2219
cargo build --release
2320
````
2421

25-
---
2622

27-
## 🧑‍💻 Usage
23+
## Usage
2824

2925
```bash
3026
./target/release/DocSense <SUBCOMMAND> [OPTIONS]
3127
```
3228

33-
### 🔍 `index <folder> [output.json]`
29+
### `index <folder> [output.json]`
3430

3531
Indexes supported files (`.xml`, `.xhtml`, `.pdf`, `.txt`, `.md`) and saves index.
3632

3733
```bash
3834
./DocSense index ./docs my_index.json
3935
```
4036

41-
### 📦 `check [index.json]`
37+
### `check [index.json]`
4238

4339
Prints how many documents are indexed.
4440

4541
```bash
4642
./DocSense check my_index.json
4743
```
4844

49-
### 🌐 `serve <index.json> [address] --rank-method <bm25|tfidf>`
45+
### `serve <index.json> [address] --rank-method <bm25|tfidf>`
5046

5147
Starts a local search server with ranking.
5248

@@ -56,16 +52,14 @@ Starts a local search server with ranking.
5652

5753
Then visit [http://localhost:8000](http://localhost:8000) in your browser.
5854

59-
---
6055

61-
## 📂 Supported Formats
56+
## Supported Formats
6257

6358
* XML / XHTML
6459
* TXT / Markdown
6560
* PDF (via Poppler)
6661

67-
---
6862

69-
## 📃 License
63+
## License
7064

71-
MIT – see [LICENSE](LICENSE) file.
65+
GPL - see [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)