docs: update readme

Author: sean2077

README.md

@@ -3,10 +3,11 @@
 
 - [jsonpath-python](#jsonpath-python)
   - [Features](#features)
+  - [Issues](#issues)
   - [Examples](#examples)
-    - [Fields-Extractor](#fields-extractor)
-    - [Multi-selection and inverse-selection filtering](#multi-selection-and-inverse-selection-filtering)
-    - [Sorting by multiple fields, ascending and descending order](#sorting-by-multiple-fields-ascending-and-descending-order)
+    - [Filter](#filter)
+    - [Sort](#sort)
+    - [Output mode: FIELD (In progress)](#output-mode-field-in-progress)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -17,13 +18,12 @@ A more powerful JSONPath implementations in modern python.
 ## Features
 
 - [x] Light. (No need to install third-party dependencies.)
-- [ ] Support fields-extractor.
-- [ ] Powerful filtering function, including multi-selection, inverse-selection filtering.
-- [ ] Powerful sorting function, including sorting by multiple fields, ascending and descending order.
-
-## Issues
-
-- Not support parent operator.
+- [x] Powerful filtering function, including multi-selection, inverse-selection filtering.
+- [x] Powerful sorting function, including sorting by multiple fields, ascending and descending order.
+- [x] Support output mode: VALUE
+- [ ] Support output mode: PATH
+- [ ] Support output mode: FIELD
+- [ ] Support parent operator
 
 ## Examples
 
@@ -68,41 +68,10 @@ data = {
 }
 ```
 
-### Fields-Extractor
-
-```python
->>> JSONPath("$.store.book[*][title,price]",result_type="FIELD").parse(data)
-```
-
-```json
-{
-  "store": {
-    "book": [
-      {
-        "title": "Sayings of the Century",
-        "price": 8.95
-      },
-      {
-        "title": "Sword of Honour",
-        "price": 12.99
-      },
-      {
-        "title": "Moby Dick",
-        "price": 8.99
-      },
-      {
-        "title": "The Lord of the Rings",
-        "price": 22.99
-      }
-    ]
-  }
-}
-```
-
-### Multi-selection and inverse-selection filtering
+### Filter
 
 ```python
->>> JSONPath("$.store.book[?(@.price>8.95 && @.price<=20 || @.title!='Sword of Honour')]").parse(data)
+>>> JSONPath('$.store.book[?(@.price>8.95 and @.price<=20 and @.title!="Sword of Honour")]').parse(data)
 ```
 
 ```json
@@ -117,10 +86,10 @@ data = {
 ]
 ```
 
-### Sorting by multiple fields, ascending and descending order
+### Sorter
 
 ```python
->>> JSONPath("$.store.book[\category,/price]").parse(data)
+>>> JSONPath("$.store.book[/(~category,price)]").parse(data)
 ```
 
 ```json
@@ -153,3 +122,34 @@ data = {
   }
 ]
 ```
+
+### Field-Extractor (In progress)
+
+```python
+>>> JSONPath("$.store.book[*][title,price]",result_type="FIELD").parse(data)
+```
+
+```json
+{
+  "store": {
+    "book": [
+      {
+        "title": "Sayings of the Century",
+        "price": 8.95
+      },
+      {
+        "title": "Sword of Honour",
+        "price": 12.99
+      },
+      {
+        "title": "Moby Dick",
+        "price": 8.99
+      },
+      {
+        "title": "The Lord of the Rings",
+        "price": 22.99
+      }
+    ]
+  }
+}
+```

test/conftest.py

@@ -16,13 +16,16 @@
         TestCase("$[book]", data, [data["book"]]),
         TestCase("$.'a.b c'", data, [data["a.b c"]]),
         TestCase("$['a.b c']", data, [data["a.b c"]]),
+        # recursive descent
         TestCase("$..price", data, [8.95, 12.99, 8.99, 22.99, 19.95]),
+        # slice
         TestCase("$.book[1:3]", data, data["book"][1:3]),
         TestCase("$.book[1:-1]", data, data["book"][1:-1]),
         TestCase("$.book[0:-1:2]", data, data["book"][0:-1:2]),
         TestCase("$.book[-1:1]", data, data["book"][-1:1]),
         TestCase("$.book[-1:-11:3]", data, data["book"][-1:-11:3]),
         TestCase("$.book[:]", data, data["book"][:]),
+        # filter
         TestCase("$.book[?(@.price>8 and @.price<9)].price", data, [8.95, 8.99]),
         TestCase('$.book[?(@.category=="reference")].category', data, ["reference"]),
         TestCase(
@@ -35,6 +38,7 @@
             data,
             ["Evelyn Waugh", "Herman Melville"],
         ),
+        # sort
         TestCase("$.book[/(price)].price", data, [8.95, 8.99, 12.99, 22.99]),
         TestCase("$.book[/(~price)].price", data, [22.99, 12.99, 8.99, 8.95]),
         TestCase("$.book[/(category,price)].price", data, [8.99, 12.99, 22.99, 8.95]),