Update README and add change-log.

This commit is contained in:
Robin KAY 2022-08-09 01:48:38 +01:00
parent c5e5c8e98f
commit d32b00f6a0
2 changed files with 29 additions and 5 deletions

15
CHANGELOG.md Normal file
View File

@ -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

View File

@ -1,5 +1,8 @@
# bevy_mod_outline # 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 This crate provides a Bevy plugin for drawing outlines around meshes using the
vertex extrusion method. vertex extrusion method.
@ -12,10 +15,10 @@ bevy_mod_outline = "0.2"
## Example ## Example
A rotating rounded cube with an outline. A rotating cube and torus with outlines.
```shell ```shell
cargo run --example cube cargo run --example shapes
``` ```
## Versions ## Versions
@ -25,7 +28,13 @@ cargo run --example cube
| 0.1.x | 0.7.x | | 0.1.x | 0.7.x |
| 0.2.x | 0.8.x | | 0.2.x | 0.8.x |
## Known Issues ## Licence
Vertex extrusion only works for meshes with smooth surface normals. Hard edges This crate is licensed under the Apache License, Version 2.0 (see
will cause visual artefacts. LICENCE-APACHE or <http://www.apache.org/licenses/LICENSE-2.0>) or the MIT
licence (see LICENCE-MIT or <http://opensource.org/licenses/MIT>), 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.