feat: added example that matches beginning of words only

folke · Jun 21, 2023 · 1e2c61d · 1e2c61d
1 parent 6d4c770
commit 1e2c61d
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -250,6 +250,20 @@ require("flash").jump({
 
 </details>
 
+<details><summary>Match beginning of words only</summary>
+
+```lua
+require("flash").jump({
+  search = {
+    mode = function(str)
+      return "\\<" .. str
+    end,
+  },
+})
+```
+
+</details>
+
 ## 📦 Alternatives
 
 - [leap.nvim](https://github.com/ggandor/leap.nvim)