diff --git a/README.org b/README.org index 19e0e68..b80c95f 100644 --- a/README.org +++ b/README.org @@ -5,6 +5,21 @@ No need for mounting via SSHFS and navigating through folders anymore. Just provide a query and the media files are played locally via [[https://mpv.io/][mpv]]. + Here is an example.. let's assume you have the shortfilm [[https://www.dailydweebs.com/][The Daily Dweebs]] stored on a remote machine in the following directory structure: + + #+begin_src text + movies + ├── The Daily Dweebs (2017) + │   └── The Daily Dweebs (2017).mkv + └── ... + #+end_src + + If strm is configured to use the =move= directory, you can play the shortfilm with the following command: + + #+begin_src sh + strm daily dweebs + #+end_src + ** Features - List remote files by query @@ -47,7 +62,7 @@ ** Configuration - The scripts expects a config file with the following content: + The scripts expects a configuration file with the following content: #+begin_src sh # SSH connection string