[nongnu] scratch/editorconfig-cc 0b314fcbea 135/351: Update README for some variables

[Stefan Monnier via]

branch: scratch/editorconfig-cc
commit 0b314fcbea9d3d3193de5a2d366916431464ed3b
Author: 10sr <8slashes+...@gmail.com>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>

    Update README for some variables
---
 README.md | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 00e484c469..77fff42692 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 
[![MELPA](http://melpa.org/packages/editorconfig-badge.svg)](http://melpa.org/#/editorconfig)
 [![MELPA 
Stable](https://stable.melpa.org/packages/editorconfig-badge.svg)](https://stable.melpa.org/#/editorconfig)
 
-This plugin also has a core library implemented in Emacs-Lisp, and fallback
-to it when no core executable is found.
+This plugin also has a built-in core library implemented in Emacs-Lisp, and
+fallback to it when no core executable is found.
 
 ```emacs-lisp
     (require 'editorconfig)
@@ -54,6 +54,37 @@ You can also modify this variable with the command
 <kbd>M-x customize-variable [RET] editorconfig-indentation-alist [RET]</kbd>.
 For a bit more compilicated cases please take a look at the docstring of this 
variable.
 
+### `editorconfig-exec-path`
+
+String of `editorconfig` executable name (command name or full path to
+the executable).
+
+
+### `editorconfig-get-properties-function`
+
+Function to use to get EditorConfig properties.
+
+For example, if you always want to use built-in core library instead
+of any EditorConfig executable to get properties, add following to
+your init.el:
+
+``` emacs-lisp
+(set-variable 'editorconfig-get-properties-function
+              #'editorconfig-core-get-properties-hash)
+```
+
+Possible known values are:
+
+* `editorconfig-get-properties` (default)
+  * Use `editorconfig-get-properties-from-exec` when
+    `editorconfig-exec-path` executable is found, otherwise use
+    `editorconfig-core-get-properties-hash`
+* `editorconfig-get-properties-from-exec`
+  * Get properties by executing EditorConfig executable specified in
+    `editorconfig-exec-path`
+* `editorconfig-core-get-properties-hash`
+  * Always use built-in Emacs-Lisp implementation to get properties
+
 ## Testing
 
 Make and [CMake](https://cmake.org) must be installed to run the tests.