Index: sitescripts/urlfixer/README.md |
=================================================================== |
new file mode 100644 |
--- /dev/null |
+++ b/sitescripts/urlfixer/README.md |
@@ -0,0 +1,38 @@ |
+urlfixer |
+======== |
+ |
+Backend for the URL Fixer data collection. It provides the following URLs: |
+ |
+* */submitData* - Receive data from URL Fixer extension |
+ |
+Required packages |
+----------------- |
+ |
+* [simplejson](http://pypi.python.org/pypi/simplejson/) |
+ |
+Database setup |
+-------------- |
+ |
+Just execute the statements in _schema.sql_. |
+ |
+Data transfer format |
+---------------------------- |
+ |
+A domain transfered to the server can have one of the following status: |
Wladimir Palant
2012/10/09 11:51:14
"Status" doesn't seem to be the right word, should
Thomas Greiner
2012/10/09 13:47:02
I tried to avoid calling them "types" due to possi
|
+ |
+* 1: the domain was entered |
Wladimir Palant
2012/10/09 11:51:14
Better: "was entered without any further action" -
|
+* 2: there was a typo |
Wladimir Palant
2012/10/09 11:51:14
Where and what does it have to do with the domain?
|
+* 3: the domain has been corrected |
Wladimir Palant
2012/10/09 11:51:14
No, this domain *is* the correction. Meaning: "the
|
+* 4: false positive (domain was corrected even though the typed domain was no typo) |
Wladimir Palant
2012/10/09 11:51:14
Better explanation: "user declined our correction"
|
+ |
+The server expects the list to be transfered as a JSON object in no particular order. Here is an example: |
+ |
+```js |
+{ |
+ "urlfixer.org": 1, |
+ "adblockplus,org": 2, |
+ "adblockplus.org": 3, |
+ "goggle.com": 1, |
+ "google.com": 4 |
+} |
+``` |