diff --git a/README.md b/README.md index 2e1d3de..d42b206 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ -# SDFMaker -A tool for converting high resolution 2D images with transparency to low resolution images with signed distance fields. +# SDF Maker +A tool for converting high resolution images or textures with transparency to low resolution images with signed distance fields. +[Runs in a browser!](https://jobtalle.com/SDFMaker) -[Runs in a browser!](https://jobtalle.com/SDFMaker) \ No newline at end of file +![Preview](preview.png) + +## How to use it? + +1. Drag an image file to the drop target on the left. This can be a .PNG image with transparency or a .SVG vector image. +2. Choose the output resolution. For good results, the output resolution should be several times smaller than the input resolution. If the input image is a .SVG image, the tool converts it to a 4k input image to ensure the input resolution is high enough. +3. Click the "generate" button to produce the output image. The output image is a .PNG image that can be downloaded. + +## Settings + +|Setting|Description| +|---|---| +|Radius|The radius of the signed distance field. This can be 1 in most cases, but it can be increased if the SDF will be used for things like outline rendering.| +|Threshold|The input image opacity threshold that is considered opaque. Any input pixel with alpha over this threshold is considered opaque.| \ No newline at end of file diff --git a/preview.png b/preview.png new file mode 100644 index 0000000..59f8668 Binary files /dev/null and b/preview.png differ