Skip to content

Commit e455873

Browse files
committed
Update readme with current status
1 parent d35baab commit e455873

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Avian Motors
22

3-
The `avian_motors` crate provides a modular motor control system for use with the `avian3d` physics engine and the `bevy` game engine. Proper motor joints are a planned feature of Avian, so this will hopefully be obsolete soon.
3+
This crate provides a modular motor control system for use with the `avian3d` physics engine and the `bevy` game engine. Proper motor joints are a planned feature of Avian, so this will hopefully be obsolete soon.
44

5-
Currently, only revolute joints are supported, but prismatic, spherical, planar, and distance joints are planned.
5+
Currently, only revolute joints are supported, but prismatic, spherical, planar, and distance joints are planned on an intermediate timeline.
66

77
## Features
88

@@ -48,3 +48,9 @@ Some basic examples are provided in the `examples/` directory.
4848

4949
`cargo run --example revolute_velocity` to control a revolute joint with velocity control.
5050
![](media/velocity.gif)
51+
52+
## Feedback and Contributions
53+
54+
Feel free to open issues or pull requests for any bugs, feature requests, or improvements
55+
Contributions are welcome!
56+
Also feel to reach out for advice on using this crate.

0 commit comments

Comments
 (0)