Merge remote-tracking branch 'origin/main' into sync-wokwi-client

Author: JakubAndrysek

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.0.5 - 2025-08-15
+
+- feat: enhance serial monitor functionality with UTF-8 decoding options (#3)
+
 ## 0.0.4 - 2025-07-06
 
 - feat: make `elf` parameter optional in `start_simulation()`

README.md

@@ -49,6 +49,27 @@ For more examples, see the [examples](examples) directory.
 
 The API documentation is available at [https://wokwi.github.io/wokwi-python-client/](https://wokwi.github.io/wokwi-python-client/).
 
+## Development
+
+To run the tests, set the `WOKWI_CLI_TOKEN` environment variable (you can get a token from [https://wokwi.com/dashboard/ci](https://wokwi.com/dashboard/ci)) and run the following command:
+
+```bash
+hatch run dev:pytest
+```
+
+To run the linter, run the following command:
+
+```bash
+hatch run ruff format --check .
+hatch run ruff check .
+```
+
+To run the type checker, run the following command:
+
+```bash
+hatch run mypy .
+```
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.