Pull

.gitignore

@@ -0,0 +1,32 @@
+*.py[co]
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+htmlcov
+.coverage
+.tox
+test/proxy_nobase64.pac
+
+#Translations
+*.mo
+
+#Mr Developer
+.mr.developer.cfg
+
+.DS_Store
+

.travis.yml

@@ -1,9 +1,12 @@
-language: python 
+language: python
 python:
   - 2.6
   - 2.7
 before_install:
   - sudo apt-get update -qq
   - sudo apt-get install -qq nodejs
+  - pip install pep8 pyflakes coverage
 script:
-  - cd test && ./test.sh
+  - pep8 .
+  - pyflakes .
+  - cd test && ./test.sh

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+Notice
+------
+
+This project does not maintain a list. It's just a tool that converts
+GFWList into PAC. Please report issues about the list to GFWList.
+
+Pull Requests
+-------------
+
+1. Pull requests are welcome. If you would like to add a large feature
+or make a significant change, make sure to open an issue to discuss with
+people first.
+2. Follow PEP8.
+3. Make sure to pass the unit tests.
+
+Issues
+------
+
+1. Only bugs and feature requests are accepted here.
+2. We'll only work on important features. If the feature you're asking only
+benefits a few people, you'd better implement the feature yourself and send us
+a pull request, or ask some of your friends to do so.
+3. We don't answer questions of any other types here. Since very few people
+are watching the issue tracker here, you'll probably get no help from here.
+Get help from forums or [mailing lists].
+4. Issues in languages other than English will be Google translated into English
+later.
+
+
+[mailing lists]:   https://groups.google.com/forum/#!forum/shadowsocks

README.md

@@ -1,14 +1,24 @@
 GFWList2PAC
 ===========
 
-[![Build Status](https://travis-ci.org/clowwindy/gfwlist2pac.png?branch=master)](https://travis-ci.org/clowwindy/gfwlist2pac)
+[![PyPI version]][PyPI]
+[![Build Status]][Travis CI]
+[![Coverage Status]][Coverage]
 
-Generate O(1) PAC file from gfwlist.
+Generate fast PAC file from gfwlist. Examples: [fast mode] / [precise mode].
 
-    pip install gfwlist2pac
+Fast mode: use O(1) domain lookup
+
+Precise mode: use adblock plus engine
+
+
+### Usage
 
-    usage: gfwlist2pac [-h] -i GFWLIST -f PAC -p PROXY
+    pip install gfwlist2pac
 
+    usage: gfwlist2pac [-h] [-i GFWLIST] -f PAC -p PROXY [--user-rule USER_RULE]
+                   [--precise]
+
     optional arguments:
       -h, --help            show this help message and exit
       -i GFWLIST, --input GFWLIST
@@ -17,3 +27,29 @@ Generate O(1) PAC file from gfwlist.
       -p PROXY, --proxy PROXY
                             the proxy parameter in the pac file, for example,
                             "SOCKS5 127.0.0.1:1080;"
+      --user-rule USER_RULE
+                            user rule file, which will be appended to gfwlist
+      --precise             use adblock plus algorithm instead of O(1) lookup
+
+### Performance
+
+The PAC generated by GFWList2PAC is 1900x faster than SwitchySharp.
+
+    Testing fast mode pac generated by gfwlist2pac
+    avg: 0.50us
+
+    Testing precise mode pac generated by gfwlist2pac
+    avg: 1.66us
+
+    Testing pac generated by switchysharp
+    avg: 952.99us
+
+
+[Build Status]:    https://img.shields.io/travis/clowwindy/gfwlist2pac/master.svg?style=flat
+[Coverage Status]: http://192.81.132.184/result/gfwlist2pac
+[Coverage]:        http://192.81.132.184/job/gfwlist2pac/ws/htmlcov/index.html
+[Travis CI]:       https://travis-ci.org/clowwindy/gfwlist2pac
+[PyPI]:            https://pypi.python.org/pypi/gfwlist2pac
+[PyPI version]:    https://img.shields.io/pypi/v/gfwlist2pac.svg?style=flat
+[fast mode]:       https://github.com/clowwindy/gfwlist2pac/blob/master/test/proxy.pac
+[precise mode]:    https://github.com/clowwindy/gfwlist2pac/blob/master/test/proxy_abp.pac

README.rst

@@ -0,0 +1,58 @@
+GFWList2PAC
+===========
+
+|PyPI version| |Build Status| |Coverage Status|
+
+Generate fast PAC file from gfwlist. Examples: `fast
+mode <https://github.com/clowwindy/gfwlist2pac/blob/master/test/proxy.pac>`__
+/ `precise
+mode <https://github.com/clowwindy/gfwlist2pac/blob/master/test/proxy_abp.pac>`__.
+
+Fast mode: use O(1) domain lookup
+
+Precise mode: use adblock plus engine
+
+Usage
+~~~~~
+
+::
+
+    pip install gfwlist2pac
+
+    usage: gfwlist2pac [-h] [-i GFWLIST] -f PAC -p PROXY [--user-rule USER_RULE]
+                   [--precise]
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -i GFWLIST, --input GFWLIST
+                            path to gfwlist
+      -f PAC, --file PAC    path to output pac
+      -p PROXY, --proxy PROXY
+                            the proxy parameter in the pac file, for example,
+                            "SOCKS5 127.0.0.1:1080;"
+      --user-rule USER_RULE
+                            user rule file, which will be appended to gfwlist
+      --precise             use adblock plus algorithm instead of O(1) lookup
+
+Performance
+~~~~~~~~~~~
+
+The PAC generated by GFWList2PAC is 1900x faster than SwitchySharp.
+
+::
+
+    Testing fast mode pac generated by gfwlist2pac
+    avg: 0.50us
+
+    Testing precise mode pac generated by gfwlist2pac
+    avg: 1.66us
+
+    Testing pac generated by switchysharp
+    avg: 952.99us
+
+.. |PyPI version| image:: https://img.shields.io/pypi/v/gfwlist2pac.svg?style=flat
+   :target: https://pypi.python.org/pypi/gfwlist2pac
+.. |Build Status| image:: https://img.shields.io/travis/clowwindy/gfwlist2pac/master.svg?style=flat
+   :target: https://travis-ci.org/clowwindy/gfwlist2pac
+.. |Coverage Status| image:: http://192.81.132.184/result/gfwlist2pac
+   :target: http://192.81.132.184/job/gfwlist2pac/ws/htmlcov/index.html