aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 34 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8d030af..615ae4e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,37 @@
-# ipman
+# IPman
Tired of copying and pasting the IP address while playing a CTF?
+## Demo
<img src="ipman.gif" alt="demo">
+
+## Install
+
+### Requirements
+* Python3
+> Install python3 with your distribution's package manager.
+
+* PyGTK
+> Follow the instructions [here](https://pygobject.readthedocs.io/en/latest/getting_started.html)
+
+* PyNput
+```bash
+python3 -m pip install pynput
+```
+
+### ipman.py
+* Use this command to get the python script.
+```bash
+wget https://raw.githubusercontent.com/compromyse/ipman/main/ipman.py
+
+OR
+
+curl -LO https://raw.githubusercontent.com/compromyse/ipman/main/ipman.py
+```
+
+* Move this script to any writable directory.
+```bash
+mv ipman.py /any/directory/ipman.py
+```
+
+### Set the keyboard shortcut
+This depends on your desktop environment. Navigate to your keyboard shortcuts setting. Add a shortcut with the command as `python3 /opt/ipman.py paste` and the shortcut as whatever you want the "paste" shortcut to be. This will be the shortcut that will paste the IP. Add another shortcut with the command as `python3 /opt/ipman.py setip` and the shortcut as whatever you want the "SetIP" shortcut to be. This shortcut will open the window to set the IP address.