resolver: added exported functions filename and freeHandle to README.md
@@ -124,3 +124,36 @@ A conflict will be raised in that situation. When processes do not lock
the file it might be overwritten. This is, however, very unlikely on
file systems with nanosecond precision.
+
+## Exported Functions and Data
+
+The resolver provides 2 functions for other plugins to use.
+
+### filename
+
+resolves `path` in with namespace `namespace`, creates a temporary file to work on and returns a struct containing the resolved data.
+
+Signature:
+ `ElektraResolved * filename (elektraNamespace namespace, const char * path, ElektraResolveTempfile tempFile, Key * warningsKey)`
+
+`ElektraResolved` and `ElektraResolveTempfile` are both defined in [shared.h](shared.h).
+
+`ElektraResolved` is a struct with the following members:
+ - `relPath`: contains the path relative to the namespace.
+ - `dirname`: contains the parent directory of the resolved file.
+ - `fullPath`: contains the full path of the resolved file.
+ - `tmpFile`: contains the full path of the created temporary file.
+
+`ElektraResolveTempfile` dictates if and where a temporarey file should be created. Possible values:
+ - `ELEKTRA_RESOLVER_TEMPFILE_NONE`: don't create a temporary file.
+ - `ELEKTRA_RESOLVER_TEMPFILE_SAMEDIR`: create a temporary file in the same directory as the resolved file.
+ - `ELEKTRA_RESOLVER_TEMPFILE_TMPDIR`: create a temporary file in `/tmp`.
+
+### freeHandle
+
+frees the handle returned by `filename`.
+
+Signature:
+ `void * freeHandle (ElektraResolved * handle)`
+
+where `handle` is the handle returned by `filename`.
