Add README and LICENSE files
This commit is contained in:
parent
1ceacc5b22
commit
643ff396fe
2 changed files with 78 additions and 0 deletions
21
LICENSE
Normal file
21
LICENSE
Normal file
|
@ -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.
|
57
README.md
Normal file
57
README.md
Normal file
|
@ -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 ❤️
|
Loading…
Reference in a new issue