From b43bd93d0f17d935b5658a5e231787e16b392a0f Mon Sep 17 00:00:00 2001 From: Spencer Gouw Date: Wed, 23 Aug 2023 07:13:08 -0700 Subject: [PATCH] Update README.md --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 219f6f2..c6534b9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # jelly-snippets A simple text snippets plugin for Obsidian.md. +## BEFORE UPDATING,READ: + +If you have used an older version of this plugin (1.5) or below, updating to version 1.6 will erase your snippets. Backup your snippets before updating; I will update the plugin with a backup functionality later too in case I mess up again. Deepest apologies. ## What does it do? @@ -76,7 +79,7 @@ It's since been incorporated back into [julia.vim](https://github.com/JuliaEdito ## Future Improvements/TODO -- [ ] Control characters in snippets (e.g. whitespace, particularly newlines? currently snippets are trimmed on both ends; should probably not trim spaces) +- [ ] Control characters in snippets - [ ] Semantic symbols in snippets (e.g. where does cursor go afterwards? a snippet with braces might benefit from placing the cursor inside...) - [ ] Regex capabilities - [ ] Bugfixes and auditing? @@ -85,4 +88,4 @@ It's since been incorporated back into [julia.vim](https://github.com/JuliaEdito ### Other caveats -- The lhs of a snippet (currently) cannot have newlines in it. Snippets of that sort will simply fail to work; they'll register but never trigger. The reason why is because I only search from cursor to start of line for snippet text; this is efficient and simple. To fix, we'd have to look backwards from the cursor position and match with the lhs of the snippet. Probably not a hard update, but given that this use case is somewhat rare (imo), I have neglected it. Do submit an issue. EDIT: the issue was submitted. Time to get to work. +- None right now, except that the maintainer of this plugin (me) is inexperienced and may break something. Keep your snippets safe if you write a lot of them.