aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..61be26b
--- /dev/null
+++ b/README.org
@@ -0,0 +1,29 @@
+* librejserver: a server program serving librejs compliance info
+
+*WIP - it does not work yet*.
+
+The program should return librejs report for a given page. It should
+return JSON for a given url:
+
+http://localhost:5678/https://fsf.org
+
+returns a JSON report of the compliance of https://fsf.org
+
+A more advanced version of this program should take user input url
+(url to a webpage, not a javascript file), run librejs compliance, and
+return the report to user. If the user is ok for the report to be
+shared, it will also be added to a database. The server can then
+serve a filtered / sorted list of urls by compliance, popularity etc.
+This can help users discover sites that are librejs-compliant.
+
+An even more advanced version of this program should list reasons for
+non-compliance of free javascript, and librejs devs can use this data
+and statistics to determine how to update the compliance check to
+cover more free javascript. A more advanced librejs can download a
+database, and add javascript to whitelist depending on some threshold
+from the data.
+
+Problem:
+
+1. This is an SaaSS
+2. Without moderation or approval, user will submit nonfree javascript