diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e8279bd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# docker container for gitbucket
+
+<span style="color:red">This docker container of gitbucket is under testing!!!</span>
+
+## usage
+Please use the configuration file `gitbucket.conf` for your personal changes.
+There are two configs available:
+- `GITBUCKET_BIND`: ip address to bind to
+- `GITBUCKET_PORT`: port to bind to