From 1981e89d46f4ad70ca3bcf3fcf35bd627c75c7f7 Mon Sep 17 00:00:00 2001
From: "Antonio J. Delgado" <ad@susurrando.com>
Date: Fri, 7 Mar 2025 15:07:16 +0200
Subject: [PATCH] first commit

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a642f5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# pass_helper
+
+## Requirements
+
+## Installation
+
+### Linux
+
+To install for example in your ~/.local/bin folder:
+```bash
+./install.sh --destination ~/.local/bin
+```
+
+To install system-wide:
+```bash
+sudo ./install.sh --destination /usr/local/bin
+```
+
+Change your configuration file in "${HOME}/.config/pass_helper.conf" (see the example in the config folder).
+
+### Windows (from PowerShell)
+
+Ensure you have "C:\Users\${env:USERNAME}\AppData\Roaming\Python\Python${python_version}\Scripts\" in your Path environment variable.
+
+  ```powershell
+& $(where.exe pip).split()[0] install .
+```
+
+## Usage
+
+  ```bash
+pass_helper.sh [--debug-level|-d CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] # Other parameters
+```