Add support for predefined variables

1 files changed, 7 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index d331181..affe1f2 100644
--- a/README.rst
+++ b/README.rst
@@ -106,6 +106,13 @@ Call ``iter()`` to get all of the output elements as an iterator:
     assert next(iterator, None) == 4
     assert next(iterator, None) == None
 
+Calling ``compile()`` with the ``args`` argument allows predefined variables to be used within the program:
+
+.. code-block:: python
+
+    program = jq.compile("$a + $b + .", args={"a": 100, "b": 20})
+    assert program.input(3).first() == 123
+
 Convenience functions are available to get the output for a program and input in one call:
 
 .. code-block:: python