Skip to content

Commit fbba92c

Browse files
committed
Add README
1 parent b2834d5 commit fbba92c

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# search-once
2+
3+
A command line application to search multiple websites at once.
4+
5+
## Installation
6+
7+
```console
8+
$ cargo install search-once
9+
```
10+
11+
## Usage
12+
13+
```console
14+
$ search-once --help
15+
A tool to search multiple websites at once
16+
17+
Usage: search-once [OPTIONS] <QUERY>
18+
19+
Arguments:
20+
<QUERY>
21+
22+
Options:
23+
-c, --config <FILE>
24+
-h, --help Print help
25+
-V, --version Print version
26+
```
27+
28+
## Configuration
29+
30+
You can customize search sites via a YAML configuration file with the following format:
31+
32+
```yaml
33+
sites:
34+
- name: GitHub Rust repos
35+
url: https://github.com/search?q=language%3ARust+%s&type=repositories
36+
- name: Crates.io
37+
url: https://crates.io/search?q=%s
38+
```
39+
40+
The `%s` placeholder in the URL will be replaced with your query.
41+
42+
The default configuration file will be automatically placed in the appropriate path based on your OS. You can find the path by running `search-once` without the `--config` option.

0 commit comments

Comments
 (0)