diff --git a/README.md b/README.md index cf88bc7..e989cc7 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,12 @@ A wayland native krunner-like runner, made with customizability in mind. # Usage +## Installation + +Clone the repository, and install the `anyrun` binary with `cargo install --path anyrun/` inside the project's directory. + +After that, build the plugins you want and configure anyrun as explained in [Configuration](Usage#Configuration). + ## Plugins Anyrun requires plugins to function, as they provide the results for input. The list of plugins in this repository is as follows: @@ -143,4 +149,4 @@ fn handler(selection: Match, data: &mut ()) -> HandleResult { plugin!(init, info, get_matches, handler, ()); ``` -And that's it! That's all of the API needed to make runners. Refer to the plugins in the [plugins](plugins) folder for more examples. \ No newline at end of file +And that's it! That's all of the API needed to make runners. Refer to the plugins in the [plugins](plugins) folder for more examples.