-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b2834d5
commit fbba92c
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# search-once | ||
|
||
A command line application to search multiple websites at once. | ||
|
||
## Installation | ||
|
||
```console | ||
$ cargo install search-once | ||
``` | ||
|
||
## Usage | ||
|
||
```console | ||
$ search-once --help | ||
A tool to search multiple websites at once | ||
|
||
Usage: search-once [OPTIONS] <QUERY> | ||
|
||
Arguments: | ||
<QUERY> | ||
|
||
Options: | ||
-c, --config <FILE> | ||
-h, --help Print help | ||
-V, --version Print version | ||
``` | ||
|
||
## Configuration | ||
|
||
You can customize search sites via a YAML configuration file with the following format: | ||
|
||
```yaml | ||
sites: | ||
- name: GitHub Rust repos | ||
url: https://github.com/search?q=language%3ARust+%s&type=repositories | ||
- name: Crates.io | ||
url: https://crates.io/search?q=%s | ||
``` | ||
The `%s` placeholder in the URL will be replaced with your query. | ||
|
||
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. |