aboutsummaryrefslogtreecommitdiff
path: root/contrib/asmap/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/asmap/README.md')
-rw-r--r--contrib/asmap/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/contrib/asmap/README.md b/contrib/asmap/README.md
new file mode 100644
index 0000000000..5fab4b285e
--- /dev/null
+++ b/contrib/asmap/README.md
@@ -0,0 +1,12 @@
+# ASMap Tool
+
+Tool for performing various operations on textual and binary asmap files,
+particularly encoding/compressing the raw data to the binary format that can
+be used in Bitcoin Core with the `-asmap` option.
+
+Example usage:
+```
+python3 asmap-tool.py encode /path/to/input.file /path/to/output.file
+python3 asmap-tool.py decode /path/to/input.file /path/to/output.file
+python3 asmap-tool.py diff /path/to/first.file /path/to/second.file
+```