diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..34d5e44 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# pkg-screenshot + +pkg-screenshot is a shell script that can display preview screenshots of packages using xdg-open. Screenshots are provided by screenshots.debian.net, so the package must exist in the Debian repositories. Please note that not all packages have screenshots available to preview. + +## Prerequisites + +pkg-screenshot requires **jq** to parse the json provided at `https://screenshots.debian.net/json/package/PACKAGENAME` and **xdg-open** to open the image URL + +## Usage + +``` +pkg-screenshot.sh package +``` |