From 4128aaf1c922b3a42241d02a1a151d9b5661c438 Mon Sep 17 00:00:00 2001 From: Nikhil Mohan Date: Fri, 23 Oct 2015 09:04:55 +0530 Subject: [PATCH] Modified README with markdown and example usage --- README | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README b/README index 2fa8990..9d38def 100644 --- a/README +++ b/README @@ -1,7 +1,9 @@ +## nude.js ## + Visit the project page: http://www.patrick-wied.at/static/nudejs/ -About +**About** nude.js is a JavaScript implementation of a nudity scanner based on approaches from research papers. HTMLCanvas makes it possible to analyse image data and afterwards decide whether it should be displayed or not. The detection algorithm runs at the client, therefore it's possible (with user interaction) to display the image even if it's identified as nude (false positive) The real world usage for client side nudity detection could be in webproxies with child security filters, and maybe even more (e.g. on social media plattforms) nude.js is Open Source. Contributions are very welcome, the goal is to build a reliable client-side nudity scanner. @@ -9,11 +11,31 @@ nude.js is Open Source. Contributions are very welcome, the goal is to build a r The algorithm is mostly based on the following paper: https://sites.google.com/a/dcs.upd.edu.ph/csp-proceedings/Home/pcsc-2005/AI4.pdf?attredirects=0 -Demo +**Usage** + +`img` element +``` html + +``` + +*action button* + +``` html +
Scan Image
+``` +*Result* + +``` html +
+``` + + +**Demo** Test the nudity detection script on several predefined images, I didn't have enough time to build a nice demo with flickr image support but feel free to test some of your images too. nude.js is currently supported in IE9(excanvas), FF 3.6+, Chrome, Safari and Opera. For really fast results try Chrome. -Contact +**Contact** If you have any questions about the project, don't hesitate to contact me: + Patrick Wied http://www.patrick-wied.at contact@patrick-wied.at