aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFrancisco Lopes <francisco@nosubstance.me>2020-11-12 21:55:59 -0300
committerFrancisco Lopes <francisco@nosubstance.me>2020-11-12 22:34:41 -0300
commit3cf2b087559f3d9778bb30883968eaa8fb8f9e38 (patch)
tree26206fd4c973adf30c762ad310ce9d9906e98249 /README.md
parentc1f6966d32f8c54a480fa60b20eb9e82c4a16a33 (diff)
downloadedit-3cf2b087559f3d9778bb30883968eaa8fb8f9e38.tar.gz
edit-3cf2b087559f3d9778bb30883968eaa8fb8f9e38.zip
Add file type and code fences support
Also fix inconsistency on usage of global variables
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 19 insertions, 6 deletions
diff --git a/README.md b/README.md
index 4318c52..3cb64df 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,28 @@
# edit-weechat
This simple [weechat](https://weechat.org/) plugin allows you to
-compose messages in your `$EDITOR`.
+compose messages in your `$EDITOR`, optionally with a file type.
# Usage
-```sh
-/edit
-# Type some stuff
-# Save and quit
-```
+- Markdown message (it's the default, same as `/edit md`)
+ ```sh
+ /edit
+ # Type some stuff
+ # Save and quit
+ ```
+- Plain text message
+ ```sh
+ /edit txt
+ # Type some stuff
+ # Save and quit
+ ```
+- Code message with fences added automatically
+ ```sh
+ /fenced cpp
+ # Type some code
+ # Save and quit
+ ```
# Configuration