update readme for web workflow support

vladak · Nov 27, 2023 · 51f9670 · 51f9670
1 parent 75e5012
commit 51f9670
Showing 1 changed file with 30 additions and 16 deletions.
diff --git a/README.rst b/README.rst
@@ -89,24 +89,32 @@ To get help, just type the command::
       A tool to manage and update libraries on a CircuitPython device.
 
     Options:
-      --verbose         Comprehensive logging is sent to stdout.
-      --version         Show the version and exit.
-      --path DIRECTORY  Path to CircuitPython directory. Overrides automatic
-                        path detection.
-      --help            Show this message and exit.
-      -r --requirement  Supports requirements.txt tracking of library
-                        requirements with freeze and install commands.
+      --verbose           Comprehensive logging is sent to stdout.
+      --path DIRECTORY    Path to CircuitPython directory. Overrides automatic
+                          path detection.
+      --host TEXT         Hostname or IP address of a device. Overrides automatic
+                          path detection.
+      --password TEXT     Password to use for authentication when --host is used.
+      --board-id TEXT     Manual Board ID of the CircuitPython device. If provided
+                          in combination with --cpy-version, it overrides the
+                          detected board ID.
+      --cpy-version TEXT  Manual CircuitPython version. If provided in combination
+                          with --board-id, it overrides the detected CPy version.
+      --version           Show the version and exit.
+      --help              Show this message and exit.
 
     Commands:
-      freeze        Output details of all the modules found on the connected...
-      install       Installs .mpy version of named module(s) onto the device.
-      install --py  Installs .py version of named module(s).
-      list          Lists all out of date modules found on the connected...
-      show          Show the long list of all available modules in the bundle.
-      show <query>  Search the names in the modules in the bundle for a match.
-      uninstall     Uninstall a named module(s) from the connected device.
-      update        Update modules on the device. Use --all to automatically update
-                    all modules.
+      bundle-add     Add bundles to the local bundles list, by "user/repo"...
+      bundle-remove  Remove one or more bundles from the local bundles list.
+      bundle-show    Show the list of bundles, default and local, with URL,...
+      freeze         Output details of all the modules found on the connected...
+      install        Install a named module(s) onto the device.
+      list           Lists all out of date modules found on the connected...
+      show           Show a list of available modules in the bundle.
+      uninstall      Uninstall a named module(s) from the connected device.
+      update         Update modules on the device. Use --all to automatically
+                     update all modules without Major Version warnings.
+
 
 
 To automatically install all modules imported by ``code.py``,
@@ -221,6 +229,12 @@ The ``--version`` flag will tell you the current version of the
     $ circup --version
     CircUp, A CircuitPython module updater. Version 0.0.1
 
+
+To use circup via the `Web Workflow <https://learn.adafruit.com/getting-started-with-web-workflow-using-the-code-editor>`_. on devices that support it. Use the ``--host`` and ``--password`` arguments before your circup command.`::
+
+    $ circup --host 192.168.1.119 --password s3cr3t install adafruit_hid
+    $ circup --host cpy-9573b2.local --password s3cr3t install adafruit_hid
+
 That's it!