docs: update README and CHANGELOG

CHANGELOG.md

@@ -106,7 +106,11 @@ Functionality, that has been **moved** to the `raillabel_providerkit`:
 
 Other breaking changes:
 - the `fromdict()` and `asdict()` methods in `raillabel.format` classes have been replaced with `from_json()` and `to_json` respectively
-- `raillabel.format.Transform` fields have been changed by `pos -> position` and `quad -> quaternion` to make it more explicit
 - `raillabel.format.FrameInterval` fields have been changed by `frame_start -> start` and `frame_end -> end` to make it more concise
-- `raillabel.format.Frame.uid` field has been removed to avoid redundant information
+- all uid fields of classes have been removed (like `raillabel.format.Frame.uid`) have been removed to avoid redundant information
 - `raillabel.format.Sensor` has been removed in favor of the different sensor type classes `raillabel.format.Camera`, `raillabel.format.Lidar`, `raillabel.format.Radar` and `raillabel.format.GpsImu`
+- `raillabel.filter()` has been removed in favor of `raillabel.Scene.filter()` with different input arguments
+
+New features:
+- `raillabel.json_format` has been introduced as an interface between the JSON format and the `raillabel` classes
+- `raillabel.scene_builder.SceneBuilder` is now available to easily build scenes for testing purposes

README.md

@@ -51,6 +51,33 @@ scene = raillabel.load("path/to/annotation_file.json")
 
 This returns a [`raillabel.Scene`](https://dsd-dbs.github.io/raillabel/code/raillabel.html#raillabel.Scene), which is the root class for the annotations.
 
+If a file is too extensive for your use-case you can filter out certain parts of a scene like this
+```python
+from raillabel.filter import (
+    IncludeObjectTypeFilter,
+    ExcludeAnnotationTypeFilter,
+    StartTimeFilter, ExcludeFrameIdFilter,
+    IncludeAttributesFilter
+)
+
+scene_with_only_trains = scene.filter([IncludeObjectTypeFilter(["rail_vehicle"])])
+
+scene_without_bboxs = scene.filter([ExcludeAnnotationTypeFilter(["bbox"])])
+
+cut_scene_with_only_red_trains = scene.filter([
+    StartTimeFilter("1587349200.004200000"),
+    ExcludeFrameIdFilter([2, 4]),
+    IncludeObjectTypeFilter(["rail_vehicle"]),
+    IncludeAttributesFilter({"color": "red"}),
+])
+```
+An overview of all available filters can be found [here](https://dsd-dbs.github.io/raillabel/code/raillabel.filter.html#module-raillabel.filter).
+
+If you then want to save your changes, then use
+```python
+raillabel.save(cut_scene_with_only_red_trains, "/path/to/target.json")
+```
+
 # Contributing
 
 We'd love to see your bug reports and improvement suggestions! Please take a