From 19ee145518b1bb3796de893166278589014f4c00 Mon Sep 17 00:00:00 2001 From: kageru Date: Wed, 15 Nov 2017 10:13:07 +0100 Subject: [PATCH] updated readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ba9f38..83f08e6 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ I should add that the focus will be on a self-hosted server. If you don't care a ``` $ pip install pysftp ``` -`escrotum` which should be available in your favorite package manager +`escrotum` and `notify-send` which should be available in your favorite package manager (or pre-installed, depending on your distribution and desktop environment). ### Usage @@ -25,5 +25,14 @@ Change all the relevant variables in `config.py` and execute ``` $ python3 pyshare ``` +to take a screenshot and upload it. Depending on your window manager, you can bind this to a hotkey. To cancel the capture, simply right-click. -The script will then, uh, terminate (which is fancy speak for crash because it really doesn't matter). \ No newline at end of file +The script will then, uh, terminate (which is fancy speak for crash because it really doesn't matter). + +You can also use the script to upload local files, mirror websites, or share your clipboard. Simply execute +``` +$ python3 pyshare -m text +``` +This is automatically choose an action based on the contents of your clipboard. Links will be downloaded and mirrored, local paths will be uploaded, and other strings will be uploaded as text files to the remote host. + +Afterwards, the link is automatically copied to clipboard.