diff --git a/README.md b/README.md index 62152b3..c42d849 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Script that, once deployed in a Docker container, monitors a live feed of the Et ## Development +Most critically `MODE=development` should be specified, as it sets the logging level from `INFO` to `DEBUG`. Low `EXPORT_INTERVAL` should be used for testing the export functionality (obviously). + ```shell mkvirtualenv chainmapper # OR 'workon chainmapper' pip3 install -r requirements.txt @@ -12,6 +14,8 @@ touch .env && echo -e "MODE=\"development\"\nEXPORT_INTERVAL=\"60\"" > .env # 60 ## Usage +The included `usage.sh` shellscript should be used for any kind of (development or production) deployment. It builds a new Docker image without caching, prompts for removal of any possible conflicting containers, and finally deploys the newly built image as a container with the `data/` local directory mounted as a volume. + ```shell chmod +x ./scripts/deploy.sh ./scripts/deploy.sh