From e83738f36dd6caec3803d709af9f2f5b51515f96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anton=C3=ADn=20Dufka?= <xdufka1@fi.muni.cz> Date: Thu, 5 Sep 2024 09:01:10 +0200 Subject: [PATCH] rename to emulator --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 02d337d..6207f69 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# CoinJoin simulation setup +# EmuCoinJoin -A container-based setup for simulating CoinJoins on RegTest network. +A container-based setup for the emulation of CoinJoin transactions on RegTest network. ## Usage 1. Install [Docker](https://docker.com/) and [Python](http://python.org/). -2. Clone the repository `git clone --recurse-submodules https://github.com/crocs-muni/coinjoin-simulator`. +2. Clone the repository `git clone --recurse-submodules https://github.com/crocs-muni/coinjoin-emulator`. 3. Install dependencies: `pip install -r requirements.txt`. 4. Run the default scenario with the default driver: `python manager.py run`. - [Scenario](#scenarios) definition file can be specified using the `--scenario` option.