2e0a5cbefd97f4e40baa2b7b351e2d44d260a59e

Author
Denys Dovhan <denysd96@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

web-search: add README (#7203)

Diff

 1diff --git a/plugins/web-search/README.md b/plugins/web-search/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..d790d944d5ad8347a37c69edd4c236d20f06b00f
 4--- /dev/null
 5+++ b/plugins/web-search/README.md
 6@@ -0,0 +1,50 @@
 7+# web-search plugin
 8+
 9+This plugin adds aliases for searching with Google, Wiki, Bing, YouTube and other popular services.
10+
11+Open your `~/.zshrc` file and enable the `web-search` plugin:
12+
13+```zsh
14+plugins=( ... web-search)
15+```
16+
17+## Usage
18+
19+You can use the `web-search` plugin in these two forms:
20+
21+* `web_search <context> <term> [more terms if you want]`
22+* `<context> <term> [more terms if you want]`
23+
24+For example, these two are equivalent:
25+
26+```zsh
27+$ web_search google oh-my-zsh
28+$ google oh-my-zsh
29+```
30+
31+Available search contexts are:
32+
33+| Context               | URL                                      |
34+|-----------------------|------------------------------------------|
35+| `bing`                | `https://www.bing.com/search?q=`         |
36+| `google`              | `https://www.google.com/search?q=`       |
37+| `yahoo`               | `https://search.yahoo.com/search?p=`     |
38+| `ddg` or `duckduckgo` | `https://www.duckduckgo.com/?q=`         |
39+| `sp` or `startpage`   | `https://www.startpage.com/do/search?q=` |
40+| `yandex`              | `https://yandex.ru/yandsearch?text=`     |
41+| `github`              | `https://github.com/search?q=`           |
42+| `baidu`               | `https://www.baidu.com/s?wd=`            |
43+| `ecosia`              | `https://www.ecosia.org/search?q=`       |
44+| `goodreads`           | `https://www.goodreads.com/search?q=`    |
45+| `qwant`               | `https://www.qwant.com/?q=`              |
46+
47+Also there are aliases for bang-searching DuckDuckGo:
48+
49+| Context   | Bang  |
50+|-----------|-------|
51+| `wiki`    | `!w`  |
52+| `news`    | `!n`  |
53+| `youtube` | `!yt` |
54+| `map`     | `!m`  |
55+| `image`   | `!i`  |
56+| `ducky`   | `!`   |