From 643ff396fee23fc46498f756a7a2e46d0abbfb15 Mon Sep 17 00:00:00 2001
From: Marty Oehme <marty.oehme@gmail.com>
Date: Sun, 8 Jan 2023 17:38:01 +0100
Subject: [PATCH] Add README and LICENSE files

---
 LICENSE   | 21 ++++++++++++++++++++
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 78 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..2fb93db
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Marty Oehme
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f7b765
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# uoeia -- Universally Open Every Image Available
+
+A small utility script which displays the specified image(s), image url(s) or image gallery url(s) using your preferred image viewer.
+
+Basically, point it to something containing images and it should open it in your image viewer.
+
+## Usage
+
+`uoeia [OPTION]... [FILE|URL]`
+
+Displays the specified image using your preferred image viewer.
+
+Can open remote urls of individual images, galleries, as well as local files at the same time.
+Uses gallery-dl for remote gallery opening - so if gallery-dl can open it, so can your image viewer.
+
+Options:
+
+  `-v`, `--viewer`       Specify the image viewer to use.
+
+  `-q`, `--quiet`        Don't display any output during normal operation.
+
+  `-g`, `--gdlopts`      Pass through options to gallery-dl. Take care to fully quote each passed option.
+
+  `-r`, `--replace`      Url patterns to replace in the format `'mypattern:::myreplacement'`
+
+  `-h`, `--help`         Show this help message and exit.
+
+## Examples
+
+`uoeia my-image.jpg`
+
+Display a local image file.
+
+`uoeia https://example.com/image`
+
+Display an image/image gallery from a URL.
+
+`uoeia -v imv https://example.com/image`
+
+Display an image from a URL using imv.
+
+`uoeia -g \"--range 1-10\" https://reddit.com/r/earthporn`
+
+Download and display the first 10 results.
+
+`uoeia -r 'nitter.net:::twitter.com' https://nitter.net/donttrythis/`
+
+Display images from twitter directly instead of its
+open source interface nitter.
+
+## Issues
+
+If you spot a bug or have an idea feel free to open an issue.
+
+Pull requests are always warmly welcomed.
+
+Thanks for using my software ❤️