readme updated

e2e_tests/.env.example

@@ -7,8 +7,3 @@ L2_RPC_URL=http://localhost:8546
 
 # Test account private key (optional, for specific tests)
 TEST_L2_PREFUNDED_PRIVATE_KEY=370e47f3c39cf4d03cb87cb71a268776421cdc22c39aa81f1e5ba19df19202f1
-
-# Contract addresses
-AVS_CONTRACT_ADDRESS=
-TAIKO_L1_ADDRESS=
-TAIKO_L2_ADDRESS=

e2e_tests/README.md

@@ -1 +1,21 @@
-# End to end preconfirmation tests
+# End to end preconfirmation tests
+
+This is a collection of end to end tests for the preconfirmation service.
+
+It requires full stack to be up and running. Usually by running
+```
+kurtosis run --enclave taiko-preconf-devnet . --args-file network_params.yaml
+```
+from the main branch of https://github.com/NethermindEth/preconfirm-devnet-package.
+
+It also requires a `.env` file to be present in the root directory. You can copy `.env.example` file into `.env` and fill in the required values.
+
+To run all tests:
+```
+pytest
+```
+
+To run a specific test with output printed:
+```
+pytest -s -v -k test_name
+```