From 383a2a4a7d656b791263307322186156c8008fd6 Mon Sep 17 00:00:00 2001
From: Ryuichi Inagaki <ryuichi.inagaki.24@googlemail.com>
Date: Sat, 17 Feb 2018 15:05:18 +1100
Subject: [PATCH] ref #5 Updated README

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/README.md b/README.md
index a9b1304..159c965 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@
 * Whole/Partial text matching
   * Matching is done depending on the current mode for whole match. You can toggle the mode from the status bar.
 * Highlighting colour is configurable
+* Save highlights that will be restored next time you open the editor
 
 Highlight/Unhighlight text. Regular expression can also be used. It highlights your text as you type.
 
@@ -51,6 +52,10 @@ You can update a highlight rule after you set it.
 
     Clear all highlights with one shot.
 
+* `Save All Highlights` (**Command ID**: `textmarker.saveAllHighlights`)
+
+    Save all highlights that will be restored when opening an editor.
+
 * `Toggle Case Sensitivity` (**Command ID**: `textmarker.toggleCaseSensitivity`)
 
     Toggle the case sensitivity of a highlight.
@@ -93,6 +98,35 @@ You can update a highlight rule after you set it.
 
     Number of milliseconds to wait before refreshing the highlights on editor contents change. `null` for no refresh.
 
+* `textmarker.savedHighlights`
+
+    List of highlights that will get applied when opening editor.
+    This value is typically set/updated by "**Save All Highlights**" command.
+
+    Sample `savedHighlights`:
+
+    ```
+    "textmarker.savedHighlights": [
+      {
+        "pattern": {
+          "type": "regex",
+          "expression": "(TODO|XXX|HACK): .*",
+          "ignoreCase": false,
+          "wholeMatch": true
+        }
+      },
+      {
+        "pattern": {
+          "type": "string",
+          "expression": "NOTE",
+          "ignoreCase": false,
+          "wholeMatch": false
+        }
+      },
+      ...
+    ]
+    ```
+
 ## Keyboard Shortcuts
 
 You can quickly invoke the above TextMarker commands by registering them to your keyboard shortcut settings. For example: