Added quick start via docker hub image

christoftorres · Feb 8, 2019 · 6fac1b1 · 6fac1b1
1 parent 3fe3f14
commit 6fac1b1
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -140,3 +140,6 @@ tools/statistics
 
 # Ignore analysis
 tools/analyser/analysis.py
+
+# Ignore website
+website
diff --git a/README.md b/README.md
@@ -5,6 +5,24 @@ HoneyBadger
 
 An analysis tool to detect honeypots in Ethereum smart contracts :honey_pot:. HoneyBadger is based on [Oyente](https://github.com/melonproject/oyente).
 
+## Quick Start
+
+A container with the dependencies set up can be found [here](https://hub.docker.com/r/christoftorres/honeybadger/).
+
+To open the container, install docker and run:
+
+```
+docker pull christoftorres/honeybadger && docker run -i -t christoftorres/honeybadger
+```
+
+To evaluate a simple honeypot inside the container, run:
+
+```
+python honeybadger/honeybadger.py -s honeypots/MultiplicatorX3.sol
+```
+
+and you are done!
+
 ## Custom Docker image build
 
 ```