Cargo.toml

@@ -2,6 +2,7 @@
 name = "web-flash"
 version = "0.2.1"
 edition = "2021"
+description = "A web server to flash Espressif devices given an ELF file."
 rust-version = "1.65"
 authors = [
     "Björn Quentin <bjoern.quentin@mobile-j.de>",

README.md

@@ -1,20 +1,42 @@
-# esp-web-flash-server
+# web-flash
 
 Starts a local server serving a web page to flash a given ELF file.
 
+## Installation
 ```
-web-flash 0.1.0
+cargo install espup
-
+```
-USAGE:
+## Usage
-    web-flash.exe [OPTIONS] --chip <CHIP> <ELF>
+```
-
+Usage: web-flash [OPTIONS] --chip <CHIP> <ELF>
-ARGS:
+
-    <ELF>
+Arguments:
-
+  <ELF>
-OPTIONS:
+          Path to the ELF file
-    -b, --bootloader <BOOTLOADER>              path to bootloader
+
-    -c, --chip <CHIP>                          chip name
+Options:
-    -h, --help                                 Print help information
+  -c, --chip <CHIP>
-    -p, --partition-table <PARTITION_TABLE>    path to partition table csv
+          Chip name
-    -V, --version                              Print version information
+
+          Possible values:
+          - esp32:   ESP32
+          - esp32c2: ESP32-C2, ESP8684
+          - esp32c3: ESP32-C3, ESP8685
+          - esp32c6: ESP32-C6
+          - esp32s2: ESP32-S2
+          - esp32s3: ESP32-S3
+          - esp32h2: ESP32-H2
+          - esp8266: ESP8266
+
+  -b, --bootloader <BOOTLOADER>
+          Path to bootloader
+
+  -p, --partition-table <PARTITION_TABLE>
+          Path to partition table CSV
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+  -V, --version
+          Print version
 ```