Update README.md

Author: VirxEC

README.md

@@ -1,18 +1,19 @@
 ## rlbot-flatbuffers
 
-A Python module implemented in Rust for serializing and deserializing RLBot's flatbuffers
+A Python module implemented in Rust for fast and safe serialization and deserialization of RLBot's flatbuffers
 
 ### The goal of this project
 
-To provide a fast, safe, and easy to use Python module for serializing and deserializing RLBot's flatbuffers.
+A majority of the code is auto-generated in the `codegen/` upon first compile
+using the RLBot's schema as defined by the `flatbuffers-schema` submodule.
 
-A majority of the code is generated in the `codegen/` upon first compile and thrown into `src/python`.
-
-This includes the code generated by `flatc` (living in `src/generated`), the Python wrapper binds to the generated Rust code, and the Python type hints (`rlbot_flatbuffers.pyi`).
+This includes the code generated by Planus (`src/planus_flat.rs`),
+the Python wrapper binds to the generated Rust code (`src/python/`),
+and the Python type hints (`rlbot_flatbuffers.pyi`).
 
 ### Dev setup
 
-- Ensure Python 3.11+ is installed
+- Ensure Python 3.10+ is installed
 - Create a virtual Python environment
   - `python3 -m venv venv`
 - Activate the virtual environment
@@ -23,7 +24,7 @@ This includes the code generated by `flatc` (living in `src/generated`), the Pyt
 - Build & install for testing
   - `maturin develop --release`
 
-To use in another Python environment, like if testing [python-interface](https://github.com/VirxEC/python-interface/blob/master/README.md?plain=1), you can build the wheel:
+To use in another Python environment, like if testing [python-interface](https://github.com/RLBot/python-interface), you can build the wheel:
 
 - `maturin build --release`
 - (In another environment) `pip install path/to/file.whl`
@@ -79,9 +80,9 @@ All values are optional when creating a class and have the proper defaults.
 import rlbot_flatbuffers as flat
 
 def handle_packet(packet: flat.GamePacket):
-    if packet.game_info.game_status not in {
-        flat.GameStatus.Active,
-        flat.GameStatus.Kickoff,
+    if packet.match_info.match_phase not in {
+        flat.MatchPhase.Active,
+        flat.MatchPhase.Kickoff,
     }:
         # Return early if the game isn't active
         return
@@ -96,10 +97,15 @@ def handle_packet(packet: flat.GamePacket):
 
 The goal of the above was to feel familiar to RLBot v4 while providing a more Pythonic interface.
 
-- All classes (not enums and unions) implement `__match_args__` for easy destructuring via the `match`/`case` pattern.
+- Classes implement `__match_args__` for easy destructuring via the `match`/`case` pattern.
   - Enums and unions and can still be used to match against the type,
     they just can't be destructured.
-- Every class implements `__str__`, `__repr__`, and `__hash__` methods.
-  - All enums also implement `__int__` and `__eq__`.
+- Classes, enums, and unions properly implements `__str__` and `__repr__`.
+- Enums implement `__hash__`, `__int__` and `__eq__`.
 - Lists no longer have `num_x` fields accompanying them,
   they are just Python lists of the appropriate length.
+- Classes implement `pack` and `unpack`,
+  which are used to serialize and deserialize data.
+  
+  These are public methods that can be used directly for any purpose,
+  for example saving `flat.GamePacket` to a file.