initial commit.main

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ffbabc8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# mdview - simple markdown viewer
+
+A simple markdown viewer with live update mode for editing. Written in posix
+shell and uses [cmark-gfm](https://github.com/github/cmark-gfm/) and
+[surf web browser](https://surf.suckless.org/). Includes install and uninstall
+scripts for convenience, made public in case someone finds it useful.
+
+## Usage
+```
+mdview [--light|--dark|--auto] [--live] <file.md>
+    --light   Light theme
+    --dark    Dark theme
+    --auto    Follow system (default)
+    --live    Watch file for changes
+```
+
+## Features
+* light and dark themes, tries to auto-detect preference by default.
+* live mode watches file and updates when saved.
+* install script so you can run it like a regular installed executable
+* cleans up after itself
+
+## dependencies
+* [cmark-gfm](https://github.com/github/cmark-gfm)
+* [surf web browser](https://surf.suckless.org)
+* inotify-tools (optional but needed for live mode)
+
+## Demo
+![Light Theme](light-demo.jpg) ![Dark Theme](dark-demo.jpg)
+