From d2db32a1fc2518852c4c3045d3c70dd22842d70a Mon Sep 17 00:00:00 2001 From: Harry Jeffery Date: Fri, 6 Nov 2015 18:01:05 +0000 Subject: Update readme --- README.md | 35 ++++++++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f431135..223029a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,20 @@ imv - Image Viewer ================== -imv is a command line image viewer intended for use with tiling window managers. +`imv` is a command line image viewer intended for use with tiling window managers. -**This software is currently in alpha.** +Currently `imv` is in **alpha**. Command line flags and shortcuts may change +without notice. + +Features +-------- + +###Wayland support + +`imv` supports Wayland out of the box. + +###Support for many file formats -Currently supported file formats: * BMP * Dr. Halo CUT * DDS @@ -39,5 +48,21 @@ Currently supported file formats: * XBM * XPM -TODO: -* GIF +Usage +----- + +### Opening images + imv image1.png another_image.jpeg yet_another.TIFF + +### Opening images via stdin + find . "*.png" | imv - + +### Sorting images + find . "*.png" | sort | imv - + +### Shuffling images + find . "*.png" | shuf | imv - + +License +------- +`imv` is published under the [MIT](LICENSE) license. -- cgit v1.2.3