diff --git a/README.md b/README.md index 20b5e52..7233fe7 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ # bevy_generative ![CodeSize](https://img.shields.io/github/languages/code-size/manankarnik/bevy_generative?style=for-the-badge) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT) -[![License](https://img.shields.io/badge/License-Apache_2.0-yellowgreen.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0) -[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue?style=for-the-badge)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking) +[![License](https://img.shields.io/badge/license-MIT%2FApache-red.svg?style=for-the-badge)](https://github.com/manankarnik/bevy_generative#license) +![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/manankarnik/bevy_generative/ci.yml?style=for-the-badge) +[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue?style=for-the-badge)](https://bevyengine.org/learn/book/plugin-development/#main-branch-tracking) [![crates.io](https://img.shields.io/crates/v/bevy_generative?style=for-the-badge)](https://crates.io/crates/bevy_generative) -[![docs.rs](https://img.shields.io/badge/docs-online-green.svg?style=for-the-badge)](https://docs.rs/bevy_generative) +[![docs.rs](https://img.shields.io/badge/docs-online-brightgreen.svg?style=for-the-badge)](https://docs.rs/bevy_generative) -Procedural generation in Bevy +`bevy_generative` is a plugin written for the [bevy engine](https://bevyengine.org/) that allows real-time procedural generation of maps, textures, terrain, planets and more! + +## Features + +- Allows procedural generation of assets which can be directly integrated in your bevy game +- Handles real-time updating of image and mesh data as configuration for the asset changes +- Builds on native as well as wasm targets +- Allows saving generated assets (uses `rfd` for native, javascript blob for wasm) +- Serializes and deserializes components using `serde` ## Installation @@ -100,15 +108,21 @@ fn setup(mut commands: Commands) { | bevy | bevy_generative | | ---- | --------------- | -| 0.12 | 0.1.0, main | +| 0.12 | 0.1, main | ## Contributing -Not accepting pull requests at this time, issues and bug reports are appreciated. +Not accepting pull requests at this time. Issues, feature requests and bug reports are appreciated. ## License -Dual-licensed under either: +All code in this repository is dual-licensed under either: + +- MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)) +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) + or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)) -- [MIT License](LICENSE-MIT) -- [Apache License, Version 2.0](LICENSE-APACHE) +at your option. +This means you can select the license you prefer! +This dual-licensing approach is the de-facto standard in the Rust ecosystem and there +are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.