Add readme

1 files changed, 27 insertions, 0 deletions

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..47de5e4
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,27 @@
+# deskwhich
+
+Search for .desktop files in XDG\_DATA_DIRS
+
+# Usage
+```
+desktopwhich [OPTIONS] <SEARCH>
+
+Arguments:
+  <SEARCH>  The desktop file to search for
+
+Options:
+      --skip-dot    Skip directories in XDG_DATA_DIRS that start with a dot
+      --skip-home   Skip directories in XDG_DATA_DIRS that start with the home directory
+  -a, --all         Print all matches in XDG_DATA_DIRS, not just the first
+      --show-tilde  Output a tilde for HOME directory
+  -h, --help        Print help
+  -V, --version     Print version
+```
+
+# Building
+```
+git clone https://codeberg.org/axtlos/desktopwhich.git
+cd desktopwhich
+cargo build --release
+```
+The executable will be placed in `./target/release`, it can be copied to any directory in PATH.