change status output

README.md

@@ -25,35 +25,43 @@ ptouch-api [--config config.toml]
 
 ## API
 
-- GET `/status`: get printer and tape status, see the
-  [ptouch-rs documentation](https://docs.rs/ptouch-rs/latest/ptouch_rs/struct.Status.html)
-  for details about the fields.
+- GET `/status`: get printer and tape status for details about the fields.
 - PUT `/print`: print the uploaded image, supports png, jpg and bmp
 
+### Status
+
+The returned status is a json with the following fields
+
+- `media_width`: width of the loaded tape in mm.
+- `pixel_width`: the width of the printed image in pixels.
+- `media_type`: material type of the loaded tape.
+- `text_color`: text color for the loaded tape.
+- `tape_color`: tape color for the loaded tape.
+
 ## Supported printers
 
 The following printers are currently supported
 
- - PT-9200DX
- - PT-2300
- - PT-2420PC
- - PT-2450PC
- - PT-1950
- - PT-2700
- - PT-1230PC
- - PT-2430PC
- - PT-1230PC_PLite
- - PT-2430PC_PLite
- - PT-2730
- - PT-H500
- - PT-E500
- - PT-P700
- - PT-P750W
- - PT-P700_PLite
- - PT-P750W_PLite
- - PT-D410
- - PT-D450
- - PT-D460BT
- - PT-D600
- - PT-D610BT
- - PT-P710BT
+- PT-9200DX
+- PT-2300
+- PT-2420PC
+- PT-2450PC
+- PT-1950
+- PT-2700
+- PT-1230PC
+- PT-2430PC
+- PT-1230PC_PLite
+- PT-2430PC_PLite
+- PT-2730
+- PT-H500
+- PT-E500
+- PT-P700
+- PT-P750W
+- PT-P700_PLite
+- PT-P750W_PLite
+- PT-D410
+- PT-D450
+- PT-D460BT
+- PT-D600
+- PT-D610BT
+- PT-P710BT