add docs for run in README (#108)

Author: madhur-tandon

README.md

@@ -28,7 +28,9 @@ $ pip install pyscript
 
 ## Usage
 
-### Embed a Python script into a PyScript HTML file
+### wrap
+
+#### Embed a Python script into a PyScript HTML file
 
 ```shell
 $ pyscript wrap <filename.py>
@@ -41,25 +43,49 @@ This can be overwritten with the `-o` or `--output` option:
 $ pyscript wrap <filename.py> -o <another_filename.html>
 ```
 
-### Open the script inside the browser using the `--show` option
+#### Open the script inside the browser using the `--show` option
 
 ```shell
 $ pyscript wrap <filename.py> --show
 ```
 
-### Set a title for the browser tab
+#### Set a title for the browser tab
 
 You can set the title of the browser tab with the `--title` option:
 
 ```shell
 $ pyscript wrap <filename.py> --title "My cool app!"
 ```
 
-### Very simple command examples with `--command` option
+#### Very simple command examples with `--command` option
 
 The `-c` or `--command` option can be used to demo very simple cases.
 In this case, if the `--show` option is used and no `--output` file is used, a temporary file will be generated.
 
 ```shell
 $ pyscript wrap -c 'print("Hello World!")' --show
 ```
+
+### run
+
+#### Spin up a local server to run on the path and specified port
+
+```shell
+$ pyscript run <path_of_folder>
+```
+
+This will serve the folder `path_of_folder` at `localhost:8000` by default
+and will open the URL in a browser window. Default is current directory if
+`path_of_folder` is not supplied.
+
+To use a different port, use `--port` option.
+
+```shell
+$ pyscript run <path_of_folder> --port 9000
+```
+
+To avoid opening a browser window, use `--silent` option.
+
+```shell
+$ pyscript run <path_of_folder> --silent
+```

src/pyscript/plugins/run.py

@@ -44,7 +44,6 @@ def split_path_and_filename(path: Path) -> tuple[Path, str]:
     Args:
         path (str): The path to the pyscript project or file.
 
-
     Returns:
         tuple(str, str): The base path of the project and the filename
     """
@@ -94,7 +93,7 @@ def start_server(path: Path, show: bool, port: int):
         except KeyboardInterrupt:
             console.print("\nStopping server... Bye bye!")
 
-            # Clean after ourselves....
+            # Clean up resources....
             httpd.shutdown()
             httpd.socket.close()
             raise typer.Exit(1)
@@ -122,7 +121,7 @@ def run(
         if e.errno == 48:
             console.print(
                 f"Error: Port {port} is already in use! :( Please, stop the process using that port"
-                f"or ry another port using the --port option.",
+                f"or try another port using the --port option.",
                 style="red",
             )
         else: