From 6e983e5f316fc033cdef418e554378a76b3dd141 Mon Sep 17 00:00:00 2001
From: Davide Depau <davide@depau.eu>
Date: Mon, 9 Sep 2019 02:06:40 +0200
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index eb81670..755a694 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 
 SecureCRT session browser for GNU/Linux and Windows Subsystem for Linux.
 
+It should also work on macOS with some changes but YMMV.
+
 At early stages, not heavily tested. Alpha quality.
 
 ## Features
@@ -11,3 +13,28 @@ At early stages, not heavily tested. Alpha quality.
 - Parse SSH sessions and generate a OpenSSH command line
 - Password is automatically copied to clipboard if found
 
+## How to use
+
+It should work both natively on GNU/Linux and on Windows under WSL, provided you have
+`bash`, `python3`, `pycrypto` for Python3 and your favorite dialog tool
+((c)`dialog` works everywhere).
+
+- Clone it with `--recursive`
+  ```
+  git clone --recursive https://github.com/Depau/shcrt.git
+  ```
+- If you forgot about it...
+  ```
+  git submodule init
+  git submodule update
+  ```
+- Simply run the script:
+  ```
+  ./shcrt
+  ```
+
+## Bugs
+
+I expect it to be full of bugs; so should you.
+
+Please report any bugs you find on GitHub :)