Skip to content

Commit 0d301e6

Browse files
committed
Update documentation
1 parent 2a898d8 commit 0d301e6

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Should work in theory on all the supported printers of flashforge-finder-api
1313

1414
## API Doc
1515

16-
The `docs` folder includes documentation for use in [Bruno](https://www.usebruno.com/), replace the ip with your server's
16+
The `docs` folder includes documentation for use in [Bruno](https://www.usebruno.com/), set the `:printerId` to that of your printers's id
1717

1818
In general, for now:
1919
* `http://localhost:8080/apis/printers` - Returns list of printer names
@@ -32,4 +32,12 @@ In general, for now:
3232
* [ ] Webhooks
3333
* [ ] Push?
3434
* [ ] Simple UI that replaces need of polar3d
35-
* [x] Use config file for printer ips, instead of manually putting IP
35+
* [x] Use config file for printer ips, instead of manually putting IP
36+
37+
# Usage
38+
39+
1. Build the project with `cargo build --release` or find a release
40+
2. Copy `config.example.toml` to `config.toml` and configure it
41+
* All sections except [printers] are optional
42+
3. Run target/release/flashforge-api or the binary file
43+
* The current directory must include the `config.toml` file

config.example.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
host = "smtp.domain.com"
44
port = 587
55
encryption = "starttls" # or "tls" or "none"
6-
user = ""
6+
user = "" # Also used for the 'from' field
77
password = ""
88

99
[notifications]

0 commit comments

Comments
 (0)