From 15c1eceed7c903f850d2fcfe4e1adc25bbbabeaf Mon Sep 17 00:00:00 2001 From: kev Date: Mon, 21 Mar 2016 12:48:39 +0800 Subject: [PATCH] update README.md --- shadowsocks/README.md | 30 ++++++++++++++++-------------- shadowsocks/libev/README.md | 25 +++++++++++++++++-------- 2 files changed, 33 insertions(+), 22 deletions(-) diff --git a/shadowsocks/README.md b/shadowsocks/README.md index abc1270..982b444 100644 --- a/shadowsocks/README.md +++ b/shadowsocks/README.md @@ -1,24 +1,22 @@ shadowsocks =========== -name | size ---------------------- | --------------------------------------------------------------------------- -shadowsocks | ![](https://badge.imagelayers.io/vimagick/shadowsocks:latest.svg) -shadowsocks-libev | ![](https://badge.imagelayers.io/vimagick/shadowsocks-libev:latest.svg) -shadowsocks-arm | ![](https://badge.imagelayers.io/vimagick/shadowsocks-arm:latest.svg) -shadowsocks-libev-arm | ![](https://badge.imagelayers.io/vimagick/shadowsocks-libev-arm:latest.svg) +name | size +-------------------------- | --------------------------------------------------------------------------- +[shadowsocks][1] | ![](https://badge.imagelayers.io/vimagick/shadowsocks:latest.svg) +[shadowsocks-libev][2] | ![](https://badge.imagelayers.io/vimagick/shadowsocks-libev:latest.svg) +[shadowsocks-arm][3] | ![](https://badge.imagelayers.io/vimagick/shadowsocks-arm:latest.svg) +[shadowsocks-libev-arm][4] | ![](https://badge.imagelayers.io/vimagick/shadowsocks-libev-arm:latest.svg) -[shadowsocks][1] is a secure socks5 proxy, -designed to protect your Internet traffic. +[shadowsocks][5] is a secure socks5 proxy, designed to protect your Internet traffic. -> If you want to keep a secret, -> you must also hide it from yourself. +> If you want to keep a secret, you must also hide it from yourself. ## docker-compose.yml For Linux Server -``` +```yaml server: image: vimagick/shadowsocks-libev ports: @@ -38,7 +36,7 @@ client: For Raspberry Pi -``` +```yaml client: image: vimagick/shadowsocks-libev-arm ports: @@ -68,5 +66,9 @@ $ docker-compose up -d client [read more][2] -[1]: http://shadowsocks.org -[2]: https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File +[1]: https://hub.docker.com/r/vimagick/shadowsocks/ +[2]: https://hub.docker.com/r/vimagick/shadowsocks-libev/ +[3]: https://hub.docker.com/r/vimagick/shadowsocks-arm/ +[4]: https://hub.docker.com/r/vimagick/shadowsocks-libev-arm/ +[5]: http://shadowsocks.org +[6]: https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File diff --git a/shadowsocks/libev/README.md b/shadowsocks/libev/README.md index f661864..752900f 100644 --- a/shadowsocks/libev/README.md +++ b/shadowsocks/libev/README.md @@ -3,15 +3,17 @@ shadowsocks-libev ![](https://badge.imagelayers.io/vimagick/shadowsocks-libev:latest.svg) -`shadowsocks-libev` is a lightweight secured socks5 proxy for embedded devices and low end boxes. +![](http://dockeri.co/image/vimagick/shadowsocks-libev) -It is a port of shadowsocks created by @clowwindy maintained by @madeye and @linusyang. +[shadowsocks-libev][1] is a lightweight secured socks5 proxy for embedded devices and low end boxes. -Compared to `vimagick/shadowsocks`, `vimagick/shadowsocks-libev` uses less cpu/memory/disk. +It is a port of shadowsocks created by [@clowwindy][2] maintained by [@madeye][3] and [@linusyang][4]. + +Compared to [vimagick/shadowsocks][5], [vimagick/shadowsocks-libev][6] uses less CPU/Memory/Disk. ## docker-compose.yml -``` +```yaml shadowsocks: image: vimagick/shadowsocks-libev ports: @@ -23,9 +25,9 @@ shadowsocks: > Please choose a strong password to protect your server. -## CPU/MEMORY +## CPU/Memory Usage -``` +```bash $ docker stats shadowsocks_shadowsocks_1 # vimagick/shadowsocks @@ -37,12 +39,19 @@ CONTAINER CPU % MEM USAGE/LIMIT MEM % shadowsocks_shadowsocks_1 0.00% 476 KiB/741 MiB 0.06% 2.334 MiB/2.341 MiB ``` -## DISK +## Disk Usage -``` +```bash $ docker images REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE vimagick/shadowsocks-libev latest a36f480e696a 8 minutes ago 15.1 MB vimagick/shadowsocks latest 35650c84852a 57 minutes ago 51.25 MB ``` + +[1]: https://github.com/shadowsocks/shadowsocks-libev +[2]: https://github.com/clowwindy +[3]: https://github.com/madeye +[4]: https://github.com/linusyang +[5]: https://hub.docker.com/r/vimagick/shadowsocks/ +[6]: https://hub.docker.com/r/vimagick/shadowsocks-libev/