diff --git a/README.md b/README.md index 4256f96..599ef29 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ Custom font family usage example: Support passing arguments by url (query or fragment) like following examples: -Passing form data (password must be encoded in base64) +Passing form data (password must be encoded in base64, privatekey not supported) ```bash http://localhost:8888/?hostname=xx&username=yy&password=str_base64_encoded ``` @@ -141,7 +141,7 @@ Passing an encoding http://localhost:8888/#encoding=gbk ``` -Passing a command +Passing a command executed right after login ```bash http://localhost:8888/?command=pwd ``` @@ -160,6 +160,11 @@ docker-compose down ### Tests +Requirements +``` +pip install pytest pytest-cov codecov flake8 mock +``` + Use unittest to run all tests ``` python -m unittest discover tests diff --git a/README.rst b/README.rst index 04d36b3..22a928c 100644 --- a/README.rst +++ b/README.rst @@ -130,7 +130,8 @@ URL Arguments Support passing arguments by url (query or fragment) like following examples: -Passing form data (password must be encoded in base64) +Passing form data (password must be encoded in base64, privatekey not +supported) .. code:: bash @@ -154,7 +155,7 @@ Passing an encoding http://localhost:8888/#encoding=gbk -Passing a command +Passing a command executed right after login .. code:: bash @@ -178,6 +179,12 @@ Tear down the app Tests ~~~~~ +Requirements + +:: + + pip install pytest pytest-cov codecov flake8 mock + Use unittest to run all tests ::