diff --git a/README.md b/README.md index a046244..54547be 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -# GIT Clone +# AbraTest +...description... + +# Usage + +To use AbraTest, follow these steps: + +## 1. GIT Clone To clone with submodules, use these git commands: @@ -8,7 +15,11 @@ git submodule update --init // add submodule after normal cloning git submodule update --remote // update submodules ``` -# Run without Docker +## Run + +You can run AbraTest with and without Docker. Choose now and follow the steps accordingly: + +## 2.1 Run without Docker ### Installation @@ -22,16 +33,16 @@ playwright install Run the script with ```bash -python main.py +python main.py # run abratest +pytest # test abratest ``` -# Run with Docker +# 2.2 Run with Docker ```bash -docker compose build -docker compose run --rm app python ./main.py -docker compose run --rm app pytest -# docker-compose up +docker compose build # build the image +docker compose run --rm app python ./main.py # run AbraTest +docker compose run --rm app pytest # test AbraTest ``` Force rebuild with cache @@ -46,7 +57,7 @@ Force rebuild wtihtout cache docker-compose build --no-cache ``` -# Codegen +## Codegen Use playwright codegen to create code for new testes easily https://playwright.dev/python/docs/codegen