Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andresribeiro authored Dec 30, 2022
1 parent f1d4db7 commit 702e7ad
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
# nsfwjs-docker

A Docker REST API for NSFW detection with [NSFWJS](https://github.com/infinitered/nsfwjs). You can find it on the Docker Hub [here](https://hub.docker.com/r/andresribeiroo/nsfwjs)
### Features ✨

## Installation
- ℹ️ Return predictions for `Neutral`, `Drawing`, `Sexy`, `Hentai` and `Porn`
- 🎯 Pretty accurate (~93%)
- 🖼️ Supports different image formats
- ⚡ 250ms to make predictions to a single image

### About 🗞️

A Docker REST API for NSFW detection with [NSFWJS](https://github.com/infinitered/nsfwjs). You can find it on the Docker Hub [here](https://hub.docker.com/r/andresribeiroo/nsfwjs). Created for my social network app, [Drakkle](https://play.google.com/store/apps/details?id=com.andresribeiro.drakkle)

### Installation ⚙️

```shell
docker run -p 3333:3333 -d --name nsfwjs andresribeiroo/nsfwjs:1.3
```

If you are deploying in production, you will probably want to pass the `--restart always` flag to start the container whenever the server restarts

## Usage
### Usage 🔨

#### One image, multipart/form-data

Expand Down Expand Up @@ -97,11 +106,3 @@ If you are deploying in production, you will probably want to pass the `--restar
]
}
```

## PS

Maybe I don't know what I'm doing. If anything starts to catch fire, move away

## Author

André Ribeiro, made for my app [Drakkle](https://drakkle.com.br)

0 comments on commit 702e7ad

Please sign in to comment.