add README

2 files changed, 30 insertions, 0 deletions

diff --git a/Dockerfile b/Dockerfile
index 5c21fb9..0f556b7 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -27,6 +27,7 @@ RUN export uid=1000 gid=1000 && \
 RUN \
   Xvfb :1 -screen 0 1366x768x16 &> xvfb.log && \
   export DISPLAY=:1.0 && \
+  touch /root/.Xauthority && \
   touch /home/developer/.Xauthority && \
   pip3 install image && \
   pip3 install python3-xlib && \
diff --git a/README.md b/README.md
index 53abc57..2cef45a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,30 @@
 # LumberJack bot [![CircleCI](https://circleci.com/gh/clarkzjw/LumberJack.svg?style=svg)](https://circleci.com/gh/clarkzjw/LumberJack)
+
+## Usage
+
+```python
+python3 bot.py
+```
+
+Make sure you have PyAutoGUI installed.
+
+If you use Debian based Linux, you can install PyAutoGUI by
+
+```bash
+sudo apt-get install scrot python3-tk python3 python3-dev python3-pip
+sudo pip3 install image
+sudo pip3 install python3-xlib
+sudo pip3 install pyautogui
+```
+
+## The Docker way
+
+Although the Docker image of this bot cannot work correctly, you can give it a try. Remember to read the comments on top of Dockerfile
+
+```bash
+docker run -it \
+-e DISPLAY=$DISPLAY \
+-v /tmp/.X11-unix:/tmp/.X11-unix \
+clarkzjw/lumberjack
+```
+