From c4fedd347d37e0f368b5c8552dc7ebc24e77de5a Mon Sep 17 00:00:00 2001
From: Marco Sarti <150066+msarti@users.noreply.github.com>
Date: Fri, 4 Oct 2024 10:48:44 +0200
Subject: [PATCH] Create INSTALL.md

---
 INSTALL.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..94a84af
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,36 @@
+# Requirements
+The following should be installed and on your PATH:
+* [bws](https://bitwarden.com/help/secrets-manager-cli/) Bitwarden Secrets Manager CLI
+* [jq](https://github.com/stedolan/jq) to manipulate the JSON
+* [fzf](https://github.com/junegunn/fzf) for selecting from multiple items
+* A utility available for your environment to copy text from a terminal, e.g. xclip for Xorg or clipboard for Wayland. By default zsh_bws uses clipboard, but you can set the command via the `ZSH_BWS_COPY_CMD` variable.
+* The `BWS_ACCESS_TOKEN` variable is set at execution time.
+
+# Installation
+## OhMyZsh (manual)
+1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)
+
+    ```sh
+    git clone https://github.com/elogiclab/zsh-bws ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-bws
+    ```
+
+2. Add the plugin to the list of plugins for Oh My Zsh to load (inside `~/.zshrc`):
+
+    ```sh
+    plugins=( 
+        # other plugins...
+        zsh-bws
+    )
+    ```
+## Antigen
+Add to your `~/.zshrc` the following line:
+
+```sh
+antigen use oh-my-zsh
+# Other bundles
+antigen bundle elogiclab/zsh-bws@main
+```
+
+
+
+