diff --git a/README.md b/README.md index b24e6f6..3e914ad 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # v2ray-docker +Dockerized v2ray(Websocket + TLS) + Let's Encrypt with official and well-maintained docker containers. No BS private containers. -Dockerized v2ray + websocket + TLS + Let's Encrypt with official and well-maintained docker containers. \ No newline at end of file +## Supports: +- v2ray with websocket + TLS protocol using the **official v2ray docker image**. +- Nginx frontend and Let's Encrypt script auto-renewal using the popular **linuxserver/letsencrypt docker image**. + +## Usage: +### Required packages +- docker-ce +- docker-compose +- python-jinja2. A popular python template processor. Should be available on most distros' package managers. + +### Building +- git clone https://github.com/quackerd/v2ray-docker +- python setup.py