Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modified README with markdown and example usage #20

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions README
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
## 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.

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
<img id="testImage2" src="damita2.jpg" width="500" height="375" alt="" />
```

*action button*

``` html
<div class="btn" onclick="nude.load('testImage2');nude.scan(function(result){ if(!result) document.getElementById('result2').innerHTML='No nude!!'; });">Scan Image</div>
```
*Result*

``` html
<div style="float:right;margin-top:-20px;" id="result2"></div>
```


**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
[email protected]