Skip to content

Commit

Permalink
readme cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
shnewto committed Mar 4, 2024
1 parent 83d3680 commit 1236c06
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@

# edges

get the edges of objects in images with transparency
get the edges of objects in images with transparency.

# using
## supported image types

- `image::DynamicImage`
- `bevy::render::texture::Image` (or if you rather, `bevy::prelude::Image`)

## using

```rust
use edges::Edges;
Expand Down Expand Up @@ -34,10 +39,6 @@ after that, we need to put the coordinates in some kind of "drawing order" so wh
crate collects all pixels, in order, that are a distance of 1 from eachother. if there are pixels that have a distance greater than 1
from any pixel in an existing group, that pixel begins a new group.

## maybe todo?

- allow input for specifying the pixel value you want to treat as "transparency"

## license

all code in this repository is dual-licensed under either:
Expand Down

0 comments on commit 1236c06

Please sign in to comment.