From bbc462f18cd1cf7be18f5ccbb1723fb0bf1b7bfd Mon Sep 17 00:00:00 2001 From: Spencer Gouw Date: Sun, 8 Oct 2023 02:03:38 -0700 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 16db8a8..0ad9db4 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,9 @@ Pretty simple. You probably have run into snippets before. Snippets are defined in a text area (like a file) in settings. Each snippet has two parts: lhs and rhs. -The lhs (left hand side) determines what text gets replaced; the rhs (right hand side) determines what replaces the text. +##### The lhs (left hand side) determines what text gets replaced; the rhs (right hand side) determines what replaces the text. + +##### The lhs is *exactly* the text that will be replaced, while the rhs can have certain symbols to represent things like whitespace. Naturally, there is a symbol to divide these two halves of a snippet, called a snippet part divider: @@ -43,6 +45,8 @@ And, there is a symbol to divide each separate snippet in the list of snippets, `-==-`, for example. +You must keep the snippet divider on their own line - that is, the plugin expects a newline after the snippet divider. (Implicitly, no two snippets can be on the same line.) + So if you had the following snippets file: ```