Skip to content

Commit 2a898d8

Browse files
committed
Update README
1 parent ac62fe5 commit 2a898d8

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
Based on [01F0/flashforge-finder-api](https://github.com/01F0/flashforge-finder-api), but written in rust.
44
I didn't like using flask for a "production server" and wanted to add some features.
55

6-
Built with rocket, but that might change
6+
Built with [Rocket](https://rocket.rs/).
7+
8+
The server by default listens on `localhost:8080`.
79

810
## Tested Printers
911
Should work in theory on all the supported printers of flashforge-finder-api
@@ -14,6 +16,7 @@ Should work in theory on all the supported printers of flashforge-finder-api
1416
The `docs` folder includes documentation for use in [Bruno](https://www.usebruno.com/), replace the ip with your server's
1517

1618
In general, for now:
19+
* `http://localhost:8080/apis/printers` - Returns list of printer names
1720
* `http://localhost:8080/apis/printers/:printerId/info` - Get printer info
1821
* `http://localhost:8080/apis/printers/:printerId/status` - Get printer status
1922
* `http://localhost:8080/apis/printers/:printerId/temperatures` - Get sensor temperatures, B for bed, T0 for main sensor
@@ -24,6 +27,9 @@ In general, for now:
2427

2528
* [ ] Built in mjpeg proxy
2629
* So multiple clients can view at once
27-
* [ ] Notifications (email, push?, webhooks?) on completion
30+
* [x] Notifications (email, push?, webhooks?) on completion
31+
* [x] Email
32+
* [ ] Webhooks
33+
* [ ] Push?
2834
* [ ] Simple UI that replaces need of polar3d
2935
* [x] Use config file for printer ips, instead of manually putting IP

0 commit comments

Comments
 (0)