Documentation and changelog

CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+First version

README.md

@@ -1,7 +1,15 @@
+<!-- cargo-sync-readme start -->
+
 # bevy_verlet
 
 [![workflow](https://github.com/ManevilleF/bevy_verlet/actions/workflows/rust.yml/badge.svg)](https://github.com/ManevilleF/bevy_verlet/actions/workflows/rust.yml)
 
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
+[![Crates.io](https://img.shields.io/crates/v/bevy_verlet.svg)](https://crates.io/crates/bevy_verlet)
+[![Docs.rs](https://docs.rs/bevy_verlet/badge.svg)](https://docs.rs/bevy_verlet)
+[![dependency status](https://deps.rs/crate/bevy_verlet/0.1.0/status.svg)](https://deps.rs/crate/bevy_verlet)
+
 Simple Verlet points and sticks implementation for bevy.
 
 ## Features
@@ -20,11 +28,10 @@ Customize *friction* and *gravity* with the `VerletConfig` resource.
 
 1. `debug`
 
-    This feature will add a *system* drawing debug lines for every stick using [bevy_prototype_debug_lines](https://crates.io/crates/bevy_prototype_debug_lines)
+This feature will add a *system* drawing debug lines for every stick using [bevy_prototype_debug_lines](https://crates.io/crates/bevy_prototype_debug_lines)
 
-2. `shuffle`
 
-    This feature will randomize the `VerletStick` computation, can be costly and make the processing jittery.
+<!-- cargo-sync-readme end -->
 
 ## Examples
 

src/components/locked.rs

@@ -1,2 +1,5 @@
+/// Component preventing application of  [`VerletPoint`][VerletPoint] physics.
+///
+/// [VerletPoint]: struct.VerletPoint.html
 #[derive(Debug, Copy, Clone)]
 pub struct VerletLocked {}

src/components/point.rs

@@ -1,5 +1,7 @@
 use bevy::math::Vec3;
 
+/// Main verlet physics component.
+/// Any entity with this component will have physics applied to it
 #[derive(Debug, Clone)]
 pub struct VerletPoint {
     pub(crate) old_position: Option<Vec3>,

src/components/stick.rs

@@ -1,8 +1,14 @@
 use bevy::prelude::Entity;
 
+/// Constraint component between two [`VerletPoint`][VerletPoint].
+///
+/// [VerletPoint]: struct.VerletPoint.html
 #[derive(Debug, Clone)]
 pub struct VerletStick {
+    /// Start `VerletPoint` entity
     pub point_a_entity: Entity,
+    /// End `VerletPoint` entity
     pub point_b_entity: Entity,
+    /// Target stick length
     pub length: f32,
 }

src/components/stick_max_tension.rs

@@ -1,6 +1,10 @@
+/// Component adding a maximum tension to a [`VerletStick`][VerletStick]
+///
 /// The stick will break when its size becomes bigger than its `length` multiplied by this factor
 ///
 /// If you set it to `1.0` the stick will break almost instantly
 /// If you set it to `2.0` the stick will break when stretched to twice its `length`
+///
+/// [VerletStick]: struct.VerletStick.html
 #[derive(Debug, Clone)]
 pub struct VerletStickMaxTension(pub f32);

src/lib.rs

@@ -1,3 +1,37 @@
+//! # bevy_verlet
+//!
+//! [![workflow](https://github.com/ManevilleF/bevy_verlet/actions/workflows/rust.yml/badge.svg)](https://github.com/ManevilleF/bevy_verlet/actions/workflows/rust.yml)
+//!
+//! [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+//! [![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
+//! [![Crates.io](https://img.shields.io/crates/v/bevy_verlet.svg)](https://crates.io/crates/bevy_verlet)
+//! [![Docs.rs](https://docs.rs/bevy_verlet/badge.svg)](https://docs.rs/bevy_verlet)
+//! [![dependency status](https://deps.rs/crate/bevy_verlet/0.1.0/status.svg)](https://deps.rs/crate/bevy_verlet)
+//!
+//! Simple Verlet points and sticks implementation for bevy.
+//!
+//! ## Features
+//!
+//! You can simply add a `VerletPoint` component on any entity with a `Transform` and the verlet physics will apply.
+//!
+//! Connect points using `VerletStick` to constrain movement (see [examples](./examples)).
+//!
+//! Lock some points by adding the `VerletLocked` component on a `VerletPoint` entity.
+//!
+//! Customize *friction* and *gravity* with the `VerletConfig` resource.
+//!
+//! > Works in 2D and 3D.
+//!
+//! ## Cargo features
+//!
+//! 1. `debug`
+//!
+//! This feature will add a *system* drawing debug lines for every stick using [bevy_prototype_debug_lines](https://crates.io/crates/bevy_prototype_debug_lines)
+//!
+#![deny(warnings)]
+#![forbid(missing_docs)]
+#![forbid(unsafe_code)]
+
 pub use {components::*, resources::*};
 
 mod components;
@@ -56,6 +90,7 @@ impl Default for BevyVerletPlugin {
 }
 
 impl BevyVerletPlugin {
+    /// Instantiates a new plugin with a custom time step
     pub fn new(time_step: f64) -> Self {
         Self {
             time_step: Some(time_step),

src/resources/config.rs

@@ -30,6 +30,7 @@ impl VerletConfig {
         1.0 - self.friction
     }
 
+    /// Retrieves the `gravity` field without the `z` axis
     pub fn gravity_2d(&self) -> Vec2 {
         Vec2::new(self.gravity.x, self.gravity.y)
     }