chore: updated readme

BowlingX · Apr 25, 2022 · 0b14192 · 0b14192
1 parent c3b0810
commit 0b14192
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -24,7 +24,11 @@ import Geschichte, { pm, factoryParameters, serializers } from 'geschichte'
 import { createBrowserHistory } from 'history'
 
 const parameterConfig = {
-  item: pm('queryParameter', serializers.string /** a basic collection of serializers is availble, like date, int, float, arrays */ )
+  item: pm(
+    'queryParameter', 
+    serializers.string, /** a basic collection of serializers is availble, like date, int, float, arrays */
+    (value?: V, initialValue?: V) => boolean  /** define an optional skip function which will determine if the parameter will be included in the url or not */
+    )
   /* ... more keys, any depth. */
 };