Added readOnly docs.

igoramadas · Apr 30, 2020 · 0fadc6b · 0fadc6b
1 parent 0577635
commit 0fadc6b
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -40,6 +40,21 @@ settings.myFTP = {
 }
 ```
 
+## Read only mode
+
+```javascript
+const setmeup = require("setmeup")
+
+// Enabling readOnly mode will prevent SetMeUp from ever writing to disk.
+setmeup.readOnly = true
+
+// File settings.secret.json (if present) will not be auto encrypted.
+setmeup.load()
+
+// Calling encrypt in readOnly mode won't work now.
+setmeup.encrypt("settings.custom.json")
+```
+
 ### Watching updates to configuration files
 
 ```javascript