README.md (v0.1)

README.md

@@ -0,0 +1,49 @@
+pwsh-vault - Basic Password Manager written in Bash+Dmenu
+=========================================================
+
+### Dependencies:
+  
+  * **Arch Linux:**
+    * `sudo pacman -S gcc make coreutils sed expat zip unzip freetype2 libxinerama xterm brotli fontconfig libbsd libmd libpng libx11 libxau libxdmcp libxft libxrender` 
+
+  * **Debian/Ubuntu:**
+    * `sudo apt install gcc make coreutils sed zip unzip libexpat1-dev libfreetype-dev libxinerama-dev x11-utils xterm libxft-dev libfreetype6-dev libfontconfig1-dev libpng-dev libbrotli-dev libxrender-dev libmd-dev libxau-dev libbsd-dev libxdmcp-dev`
+
+### Build and install:
+
+* Open terminal and run the following commands:
+
+  ```shell
+  $ git clone http://vmi826324.contaboserver.net:3000/q3aql/pwsh-vault
+  $ sudo make install clean
+  ````
+
+### GUI Version:
+
+  ```shell
+  pwsh-vault
+  ```
+
+<img src="examples/pwsh-vault.png" /> 
+
+ 
+### CLI Version:
+
+  ```shell
+  pwsh-vault-cli
+  ```
+
+<img src="examples/pwsh-vault-cli.png" /> 
+
+
+  ```shell
+  pwsh-vault (or pwsh-vault-cli) --help
+  ```
+
+<img src="examples/pwsh-vault-help.png" /> 
+
+
+### External links:
+
+  * [dmenu homepage](https://tools.suckless.org/dmenu/)
+