From 1da9daa6054c7b31be140e0b61b1a93e185778ab Mon Sep 17 00:00:00 2001 From: Andrej Benz Date: Tue, 8 Aug 2023 14:08:00 +0200 Subject: [PATCH] readme: added websearch (#76) --- README.md | 27 ++++++++++++++++----------- flake.nix | 5 +++++ plugins/websearch/README.md | 18 ++++++++++++++++++ 3 files changed, 39 insertions(+), 11 deletions(-) create mode 100644 plugins/websearch/README.md diff --git a/README.md b/README.md index 3c07598..ef27396 100644 --- a/README.md +++ b/README.md @@ -63,19 +63,22 @@ You can use the flake: ``` The flake provides multiple packages: - - anyrun (default) - just the anyrun binary - - anyrun-with-all-plugins - anyrun and all builtin plugins - - applications - the applications plugin - - dictionary - the dictionary plugin - - kidex - the kidex plugin - - randr - the randr plugin - - rink - the rink plugin - - shell - the shell plugin - - stdin - the stdin plugin - - symbols - the symbols plugin - - translate - the translate plugin + +- anyrun (default) - just the anyrun binary +- anyrun-with-all-plugins - anyrun and all builtin plugins +- applications - the applications plugin +- dictionary - the dictionary plugin +- kidex - the kidex plugin +- randr - the randr plugin +- rink - the rink plugin +- shell - the shell plugin +- stdin - the stdin plugin +- symbols - the symbols plugin +- translate - the translate plugin +- websearch - the websearch plugin #### home-manager module + We have a home-manager module available at `homeManagerModules.default`. You use it like this: ```nix @@ -171,6 +174,8 @@ Anyrun requires plugins to function, as they provide the results for input. The - Should generally be used exclusively with the `-o` argument. - [Dictionary](plugins/dictionary/README.md) - Look up definitions for words +- [Websearch](plugins/websearch/README.md) + - Search the web with configurable engines: Google, Ecosia, Bing, DuckDuckGo. ## Configuration diff --git a/flake.nix b/flake.nix index feb30c1..94af9b6 100644 --- a/flake.nix +++ b/flake.nix @@ -99,6 +99,11 @@ inherit inputs lockFile; name = "translate"; }; + + websearch = pkgs.callPackage ./nix/plugins/default.nix { + inherit inputs lockFile; + name = "websearch"; + }; }; }; diff --git a/plugins/websearch/README.md b/plugins/websearch/README.md new file mode 100644 index 0000000..ca5d558 --- /dev/null +++ b/plugins/websearch/README.md @@ -0,0 +1,18 @@ +# Websearch + +Search with your preferred search-engine. You can configure multiple engines. + +## Usage + +Enter your search-term and select the resulting search action you want to perform. + +## Configuration + +Default config + +``` +Config( + prefix: "?", + engines: [Google] // options: Google, Ecosia, Bing, DuckDuckGo +) +```