Update README.md

README.md

@@ -0,0 +1,49 @@
+Anonymous Github
+================
+
+Similarly to paper anonymization, in a double-blind review process, the open-science data or code that is in the online appendix must be anonymized. The authors must
+
+* anonymize URLs: the name of the institution/department/group/authors should not appear in the  URLs of the open-science appendix
+* anonymize the appendix content itself
+
+Anonymizing an open-science appendix needs some work, but fortunately, this can be automated, this is what Anonymous Github is about.
+
+Anonymous Github anonymizes:
+* the Github owner / organization / repository name
+* the content of the repository
+
+
+Using Anonymous Github
+-----------------------
+
+To use it, open the main page (eg [http://anonymous.4open.science/](http://anonymous.4open.science/)), and simply fill 
+1) the Github repo URL and 2) the word list (which can be updated afterwards). 
+The anonymization of the content is done by replacing all occurrences of words in a list by "XXX". 
+The word list is provided by the authors, and typically contains the institution name, author names, logins, etc...
+
+In a paper under double-blind review, instead of putting a link to Github, one puts a link to the Anonymous Github instance (eg 
+<http://anonymous.4open.science/1234> which is an anomyous version of this repo).
+
+To start using Anonymous Github right now, a public instance of anonymous_github is hosted at 4open.science:
+
+**[http://anonymous.4open.science/](http://anonymous.4open.science/)**
+
+
+How it works?
+--------------
+
+The anonymization of the URL is achieved though proxying all requests.
+
+Installing Anonymous Github
+----------------------------
+
+```
+git clone https://github.com/tdurieux/anonymous_github/
+cd anonymous_github
+pip install -r requirements.txt
+python server.py
+```
+See also
+--------
+
+* [Open-science and Double-blind Peer-Review](http://www.monperrus.net/martin/open-science-double-blind)