Skip to content

Commit 5a5158b

Browse files
author
clowwindy
committed
update url
1 parent 7f19c31 commit 5a5158b

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

‎README.rst

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
shadowsocks
22
===========
33

4-
|PyPI version| |Build Status|
4+
|PyPI version| |Build Status| |Coverage Status|
55

66
A fast tunnel proxy that helps you bypass firewalls.
77

8-
`中文说明 <https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E>`__
8+
`中文说明 <https://github.com/shadowsocks/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E>`__
99

1010
Install
1111
-------
@@ -16,12 +16,12 @@ server.
1616
Client
1717
~~~~~~
1818

19-
- `Windows <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows>`__
19+
- `Windows <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#windows>`__
2020
/ `OS
2121
X <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help>`__
22-
- `Android <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android>`__
22+
- `Android <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#android>`__
2323
/ `iOS <https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help>`__
24-
- `OpenWRT <https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt>`__
24+
- `OpenWRT <https://github.com/shadowsocks/shadowsocks/wiki/Ports-and-Clients#openwrt>`__
2525

2626
Server
2727
~~~~~~
@@ -77,27 +77,27 @@ On your server create a config file ``/etc/shadowsocks.json``. Example:
7777

7878
Explanation of the fields:
7979

80-
+------------------+---------------------------------------------------------------------------------------------------------+
81-
| Name | Explanation |
82-
+==================+=========================================================================================================+
83-
| server | the address your server listens |
84-
+------------------+---------------------------------------------------------------------------------------------------------+
85-
| server\_port | server port |
86-
+------------------+---------------------------------------------------------------------------------------------------------+
87-
| local\_address | the address your local listens |
88-
+------------------+---------------------------------------------------------------------------------------------------------+
89-
| local\_port | local port |
90-
+------------------+---------------------------------------------------------------------------------------------------------+
91-
| password | password used for encryption |
92-
+------------------+---------------------------------------------------------------------------------------------------------+
93-
| timeout | in seconds |
94-
+------------------+---------------------------------------------------------------------------------------------------------+
95-
| method | default: "aes-256-cfb", see `Encryption <https://github.com/clowwindy/shadowsocks/wiki/Encryption>`__ |
96-
+------------------+---------------------------------------------------------------------------------------------------------+
97-
| fast\_open | use `TCP\_FASTOPEN <https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open>`__, true / false |
98-
+------------------+---------------------------------------------------------------------------------------------------------+
99-
| workers | number of workers, available on Unix/Linux |
100-
+------------------+---------------------------------------------------------------------------------------------------------+
80+
+------------------+-----------------------------------------------------------------------------------------------------------+
81+
| Name | Explanation |
82+
+==================+===========================================================================================================+
83+
| server | the address your server listens |
84+
+------------------+-----------------------------------------------------------------------------------------------------------+
85+
| server\_port | server port |
86+
+------------------+-----------------------------------------------------------------------------------------------------------+
87+
| local\_address | the address your local listens |
88+
+------------------+-----------------------------------------------------------------------------------------------------------+
89+
| local\_port | local port |
90+
+------------------+-----------------------------------------------------------------------------------------------------------+
91+
| password | password used for encryption |
92+
+------------------+-----------------------------------------------------------------------------------------------------------+
93+
| timeout | in seconds |
94+
+------------------+-----------------------------------------------------------------------------------------------------------+
95+
| method | default: "aes-256-cfb", see `Encryption <https://github.com/shadowsocks/shadowsocks/wiki/Encryption>`__ |
96+
+------------------+-----------------------------------------------------------------------------------------------------------+
97+
| fast\_open | use `TCP\_FASTOPEN <https://github.com/shadowsocks/shadowsocks/wiki/TCP-Fast-Open>`__, true / false |
98+
+------------------+-----------------------------------------------------------------------------------------------------------+
99+
| workers | number of workers, available on Unix/Linux |
100+
+------------------+-----------------------------------------------------------------------------------------------------------+
101101

102102
On your server:
103103

@@ -134,7 +134,7 @@ Documentation
134134
-------------
135135

136136
You can find all the documentation in the wiki:
137-
https://github.com/clowwindy/shadowsocks/wiki
137+
https://github.com/shadowsocks/shadowsocks/wiki
138138

139139
License
140140
-------
@@ -144,12 +144,14 @@ MIT
144144
Bugs and Issues
145145
---------------
146146

147-
- `Troubleshooting <https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting>`__
147+
- `Troubleshooting <https://github.com/shadowsocks/shadowsocks/wiki/Troubleshooting>`__
148148
- `Issue
149-
Tracker <https://github.com/clowwindy/shadowsocks/issues?state=open>`__
149+
Tracker <https://github.com/shadowsocks/shadowsocks/issues?state=open>`__
150150
- `Mailing list <http://groups.google.com/group/shadowsocks>`__
151151

152152
.. |PyPI version| image:: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
153153
:target: https://pypi.python.org/pypi/shadowsocks
154-
.. |Build Status| image:: https://img.shields.io/travis/clowwindy/shadowsocks/master.svg?style=flat
155-
:target: https://travis-ci.org/clowwindy/shadowsocks
154+
.. |Build Status| image:: https://img.shields.io/travis/shadowsocks/shadowsocks/master.svg?style=flat
155+
:target: https://travis-ci.org/shadowsocks/shadowsocks
156+
.. |Coverage Status| image:: http://192.81.132.184/result/shadowsocks
157+
:target: http://192.81.132.184/job/Shadowsocks/ws/htmlcov/index.html

0 commit comments

Comments
 (0)