aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorA Farzat <a@farzat.xyz>2022-05-14 16:17:42 +0900
committerA Farzat <a@farzat.xyz>2022-05-14 16:17:42 +0900
commit42cbe43c76ac89edb27819db6e33a804ac3bf922 (patch)
tree65ac566f5a2e7c4e95ef37ceca85daf77342dc4f /README.md
parent8499a1e4730828b46cdf03dfc285556b70a1a610 (diff)
parent3cf2b087559f3d9778bb30883968eaa8fb8f9e38 (diff)
downloadedit-42cbe43c76ac89edb27819db6e33a804ac3bf922.tar.gz
edit-42cbe43c76ac89edb27819db6e33a804ac3bf922.zip
Merge branch 'oblitum/extension-and-fences'
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