diff --git a/docs/usage.rst b/docs/usage.rst index 4b8db42..d922d4a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -14,12 +14,29 @@ Or, alternatively: python -m senpy -This will create a server with any modules found in the current path. In case you want to load modules that are in a different folders under the same path, use the next option. +This will create a server with any modules found in the current path. + +Useful command-line options +================= + +In case you want to load modules that are in different folders under the same path, use the next option. .. code:: bash python -m senpy -f . +The default port used by senpy is 5000, but you can change it using the option `--port`. + +.. code:: bash + + python -m senpy --port 8080 + +Also, the host can be changed where senpy is deployed. The default value is `127.0.0.1`. + +.. code:: bash + + python -m senpy --host 125.1.2.3 + For more options, see the `--help` page. Alternatively, you can use the modules included in senpy to build your own application.