aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHarry Jeffery <harry@exec64.co.uk>2015-11-06 18:01:05 +0000
committerHarry Jeffery <harry@exec64.co.uk>2015-11-06 18:20:52 +0000
commitd2db32a1fc2518852c4c3045d3c70dd22842d70a (patch)
tree67a109610298935cf1b83c86da08dcfe165a6fa3 /README.md
parent981c791ee9dad0daa03c1cd601727b14c17ec6d8 (diff)
downloadimv-d2db32a1fc2518852c4c3045d3c70dd22842d70a.tar.gz
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files 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.