aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/README.md')
-rw-r--r--scripts/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 000000000..eb6caff42
--- /dev/null
+++ b/scripts/README.md
@@ -0,0 +1,12 @@
+# run_bp.py
+
+This script is used for running Tangerine Network BP node. The script itself
+supports automatic upgrade (AU), as well as automatically upgrading the node
+docker image.
+
+## Updating
+
+Whenever `run_bp.py` is changed, `run_bp.py.sha1` needs to be updated
+correspondingly with:
+
+ sha1sum run_bp.py | awk '{ print $1 }' > run_bp.py.sha1