From 0812559a6c6ad392da6c3275b484f93ff8ab88aa Mon Sep 17 00:00:00 2001
From: Roman <zajic@zajic.net>
Date: Fri, 13 Dec 2024 10:50:56 +0800
Subject: [PATCH] Readme

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..592ddb9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# nomos-e2e-tests
+
+Nomos e2e framework used to test various implementations of the Nomos node.
+
+## Setup and contribute
+
+```shell
+git clone git@github.com:logos-co/nomos-e2e-tests.git
+cd nomos-e2e-tests
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+pre-commit install
+(optional) Overwrite default vars from src/env_vars.py via cli env vars or by adding a .env file
+pytest
+```
+
+## License
+
+Licensed and distributed under either of
+
+- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT
+
+or
+
+- Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0)
+
+at your option. These files may not be copied, modified, or distributed except according to those terms.