summaryrefslogtreecommitdiff
path: root/plugins/copypath/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/copypath/README.md')
-rw-r--r--plugins/copypath/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/copypath/README.md b/plugins/copypath/README.md
new file mode 100644
index 000000000..1e5a463a6
--- /dev/null
+++ b/plugins/copypath/README.md
@@ -0,0 +1,15 @@
+# copypath plugin
+
+Copies the path of given directory or file to the system clipboard.
+
+To use it, add `copypath` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... copypath)
+```
+
+## Usage
+
+- `copypath`: copies the absolute path of the current directory.
+
+- `copypath <file_or_directory>`: copies the absolute path of the given file.