diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..232c76a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Changelog + +## bevy_mod_outline 0.2.0 (2022-08-09) + +### Added +- Added support for outline normals. + +### Changed +- Updated Bevy dependency to 0.8. +- Changed from rendering in main pass to separate pass. +- Changed from using asset handles to plain components. + +## bevy_mod_outline 0.1.0 (2022-06-14) + +- Initial release diff --git a/README.md b/README.md index 95b327c..0a848c6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # bevy_mod_outline +[![crates.io](https://img.shields.io/crates/v/bevy_mod_outline.svg)](https://crates.io/crates/bevy_mod_outline) +[![docs](https://docs.rs/bevy_mod_outline/badge.svg)](https://docs.rs/bevy_mod_outline) + This crate provides a Bevy plugin for drawing outlines around meshes using the vertex extrusion method. @@ -12,10 +15,10 @@ bevy_mod_outline = "0.2" ## Example -A rotating rounded cube with an outline. +A rotating cube and torus with outlines. ```shell -cargo run --example cube +cargo run --example shapes ``` ## Versions @@ -25,7 +28,13 @@ cargo run --example cube | 0.1.x | 0.7.x | | 0.2.x | 0.8.x | -## Known Issues +## Licence -Vertex extrusion only works for meshes with smooth surface normals. Hard edges -will cause visual artefacts. +This crate is licensed under the Apache License, Version 2.0 (see +LICENCE-APACHE or ) or the MIT +licence (see LICENCE-MIT or ), at your +option. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall +be dual licensed as above, without any additional terms or conditions.