From 8aac6bbd2ced985d3d0f647fad82d468ec994a30 Mon Sep 17 00:00:00 2001 From: Alex Schroeder Date: Wed, 14 Aug 2019 12:59:05 +0200 Subject: [PATCH] README: add example with preview --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 1d1e66a..d6efc4c 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,44 @@ written. If none exists, the first one is going to be created by the Any further commands you put into the file are simple executed as if you were to type them every time you start the program. +Notes +----- + +One thing I care about is editing comments with my favourite editor +and previewing them. This works really well if you have `mdcat` as it +renders Markdown. Here's the workflow: + +1. check notifications +2. pick a post +3. show latest comments +4. compose a note +5. preview note +6. leave a comment with that note + +This is what it looks like, assuming your editor is `ed`: + +``` +> notifications +... +> 1 +... +> comments +... +> note nice +/home/alex/.config/jan-pona-mute/notes/nice: No such file or directory +a +OK, I like this. Thanks! +. +w +25 +q + 1. nice +Use 'edit' to create a note. +> preview 1 +OK, I like this. Thanks! +> comment 1 +``` + Reference --------- -- 2.25.1