Skip to content

Commit 04aeafd

Browse files
improved readme
1 parent f891b41 commit 04aeafd

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ cargo run --bin cratedocs test --tool lookup_item --crate-name tokio --item-path
5555
# Look up documentation for a specific version
5656
cargo run --bin cratedocs test --tool lookup_item --crate-name serde --item-path Serialize --version 1.0.147
5757

58+
# Look up a trait in a crate (e.g., the Serialize trait in serde) & a specific version
59+
cargo run --bin cratedocs test --tool lookup_item --crate-name serde --item-path serde::Serialize --version 1.0.160
60+
5861
# Search for crates
5962
cargo run --bin cratedocs test --tool search_crates --query logger --limit 5
6063

@@ -64,8 +67,9 @@ cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio --format t
6467

6568
# Save output to a file
6669
cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio --output tokio-docs.md
67-
# Summarize output by stripping LICENSE and VERSION sections
68-
cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio --tldr
70+
71+
# Summarize output by stripping LICENSE and VERSION sections, limits to xxxxx tokens (uses huggingface tokenizer)
72+
cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio --tldr --max_tokens 48000
6973
```
7074

7175
By default, the HTTP server will listen on `http://127.0.0.1:8080/sse`.

0 commit comments

Comments
 (0)