add operators docs and fix todo links
4 files changed, 28 insertions(+), 8 deletions(-)

M HISTORY.md
M contributing.md
M docs/index.md
M docs/usage.md
M HISTORY.md +1 -1
@@ 1,6 1,6 @@ 
 # History
 
-## 0.1.4 (2020-12-08)
+## 0.1.4 (2020-12-10)
 
 #### Features
 

          
M contributing.md +1 -1
@@ 9,7 9,7 @@ You can contribute in many ways:
 
 ### Report Bugs
 
-Report bugs at <https://sr.ht/~ocurero/sqlalchemy-querybuilder/trackers>.
+Report bugs at <https://todo.sr.ht/~ocurero/sqlalchemy-querybuilder>.
 
 If you are reporting a bug, please include:
 

          
M docs/index.md +2 -2
@@ 1,6 1,6 @@ 
 # Welcome to sqlalchemy-querybuilder’s documentation
 
-sqlalchemy-querybuilder is a package that implements a sqlalchemy query builder for json
+sqlalchemy-querybuilder is a package that implements a sqlalchemy query builder for 
 rules generated with (but not limited to)
 [jQuery QueryBuilder](http://querybuilder.js.org/).
 

          
@@ 12,7 12,7 @@ rules generated with (but not limited to
 * Open Source: Apache 2.0 license.
 * Website: <https://sr.ht/~ocurero/sqlalchemy-querybuilder/>.
 * Documentation: <https://sqlalchemy-querybuilder.readthedocs.io/>.
-* Repository: <https://hg.sr.ht/~ocurero/sqlalchemy-querybuilder>.
+* Repository (mercurial): <https://hg.sr.ht/~ocurero/sqlalchemy-querybuilder>.
 
 ## Quick start
 

          
M docs/usage.md +24 -4
@@ 6,11 6,31 @@ The entirety of sqlalchemy-querybuilder’s functionality is encapsulated in the Filter class.
 
 Filter class accepts three parameters:
 
- - `models` can be either a module defining classes which inherit from
+ - `models` (required) can be either a module defining classes which inherit from
    [`declarative_base`](https://docs.sqlalchemy.org/en/13/orm/extensions/declarative/api.html#sqlalchemy.ext.declarative.declarative_base) or a dictionary of such classes with the name of the tables as keys.
- - `query` is a SQLAlchemy query object. Optionaly loaded with some entity.
- - `operators` is a dictionary of allowed operators. By default all supported operators are
-   allowed.
+ - `query` (required) is a SQLAlchemy query object. Optionaly loaded with some entity.
+ - `operators` (optional) is a dictionary of operators. By default all operators are
+   enabled. This is how they are all implemented:
+    -  **equal** &rarr; `__eq__(x)`
+	-  **not_equal** &rarr; `__ne__(x)`
+	-  **less** &rarr; `__lt__(x)`
+    -  **greater** &rarr; `__gt__(x)`
+    -  **less_or_equal** &rarr; `__le__(x)`
+    -  **greater_or_equal** &rarr; `__ge__(x)`
+    -  **in** &rarr; `in_(x)`
+    -  **not_in** &rarr; `notin_(x)`
+    -  **ends_with** &rarr; `like('%' + x)`
+    -  **begins_with** &rarr; `like(x + '%')`
+    -  **contains** &rarr; `like('%' + x + '%')`
+    -  **not_contains** &rarr; `notlike('%' + x + '%')`
+    -  **not_begins_with** &rarr; `notlike(x + '%')`
+    -  **not_ends_with** &rarr; `notlike('%' + x)` 
+    -  **is_empty** &rarr; `__eq__('')`
+    -  **is_not_empty** &rarr; `__ne__('')`
+    -  **is_null** &rarr; `is_(None)`
+    -  **is_not_null** &rarr; `isnot(None)`
+    -  **between** &rarr; `between(x[0], x[1])`
+
 
 `Filter` only has one method: querybuilder. This method only accepts `rules` parameter, which is a dictionary that holds rules processed by jquery QueryBuilder or compatible.