From 3279c505e7facce7bb375d4a04bf784397328172 Mon Sep 17 00:00:00 2001
From: mathieuprog <5883963+mathieuprog@users.noreply.github.com>
Date: Mon, 13 Jul 2020 11:11:07 +0200
Subject: [PATCH] Update code docs

---
 lib/query_builder.ex | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/lib/query_builder.ex b/lib/query_builder.ex
index 5f73c67..d2a304f 100644
--- a/lib/query_builder.ex
+++ b/lib/query_builder.ex
@@ -49,6 +49,12 @@ defmodule QueryBuilder do
   ```
   QueryBuilder.where(query, [role: :permissions], name@permissions: :write)
   ```
+
+  OR clauses may be passed through last argument `opts`. For example:
+
+  ```elixir
+  QueryBuilder.where(query, [], [firstname: "John"], or: [firstname: "Alice", lastname: "Doe"], or: [firstname: "Bob"])
+  ```
   """
   def where(query, assoc_fields, filters, opts \\ []) do
     ensure_query_has_binding(query)