README first pass

README.md

@@ -1,11 +1,22 @@
-# mlv
-[![Crates.io](https://img.shields.io/crates/v/mini-log-viewer)](https://crates.io/crates/mini-log-viewer) 
-[![Docs.rs](https://docs.rs/mini-log-viewer/badge.svg)](https://docs.rs/mini-log-viewer) 
+# Mini Log Viewer
+[![Crates.io](https://img.shields.io/crates/v/mini-log-viewer)](https://crates.io/crates/mini-log-viewer)
 [![Build](https://github.com/Ewpratten/mlv/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/mlv/actions/workflows/build.yml)
 [![Clippy](https://github.com/Ewpratten/mlv/actions/workflows/clippy.yml/badge.svg)](https://github.com/Ewpratten/mlv/actions/workflows/clippy.yml)
 
+`mlv` is a small log viewer application that works with files and streams.
 
-repo description
+![A screenshot of MLV in use](./screenshot.png)
+
+```sh
+# Reading a file
+mlv /path/to/file.log
+
+# Reading Journalctl output
+mlv -p journal-json <(journalctl -o json -f)
+
+# Reading from a remote machine
+mlv <(ssh user@host "cat /path/to/remote.log")
+```
 
 ## Installation
 
@@ -14,3 +25,5 @@ This crate can be installed via `cargo` with:
 ```sh
 cargo install mini-log-viewer
 ```
+
+Don't forget, the installed binary is called `mlv`.