Rename serialize feature to serde

Follow rust API guidelines: https://rust-lang.github.io/api-guidelines/naming.html#feature-names-are-free-of-placeholder-words-c-feature
SergioRibera · Nov 2, 2023 · da8c7f3 · da8c7f3
1 parent f2c0fc1
commit da8c7f3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,8 +19,8 @@ name = "simple"
 name = "multiple"
 
 [features]
-default = ["serialize"]
-serialize = ["serde"]
+default = ["serde"]
+serde = ["dep:serde"]
 
 [dependencies]
 bevy = { version = "0.11", default-features = false, features = [

diff --git a/README.md b/README.md
@@ -45,13 +45,13 @@ Aviable and compatible versions
 
 # Features
 
-- serialize (default): for serialization support for all types (usable for save and load settings)
+- `serde` (default): for serialization support for all types through [`serde`](https://serde.rs) (useful for save and load settings)
 
 ```toml
 virtual_joystick = {
  version = "*",
  default-features = false,
- features = [ "serialize" ]
+ features = [ "serde" ]
 }
 ```
 

diff --git a/src/behaviour.rs b/src/behaviour.rs
@@ -1,10 +1,10 @@
 use bevy::prelude::*;
 
-#[cfg(feature = "serialize")]
+#[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
 #[derive(Reflect, Clone, Copy, Debug, Default, PartialEq, Eq)]
-#[cfg_attr(feature = "serialize", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum VirtualJoystickAxis {
  #[default]
  Both,
@@ -35,7 +35,7 @@ impl VirtualJoystickAxis {
 }
 
 #[derive(Reflect, Clone, Copy, Debug, Default, PartialEq, Eq)]
-#[cfg_attr(feature = "serialize", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum VirtualJoystickType {
  /// Static position
  Fixed,