Merge branch 'develop'

Cargo.toml

@@ -2,6 +2,14 @@
 name = "motor_toolbox_rs"
 version = "0.1.0"
 edition = "2021"
+license = "Apache-2.0"
+authors = ["Pollen Robotics"]
+description = "Motor Toolbox for Rust"
+homepage = "https://pollen-robotics.com"
+repository = "https://github.com/pollen-robotics/motor-toolbox-rs"
+readme = "README.md"
+keywords = ["motor", "toolbox", "robotics"]
+categories = ["science::robotics"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README.md

@@ -1 +1,29 @@
-# motor_toolbox_rs
+# Motor toolbox in Rust
+
+[![Build Status]][actions] [![Latest Version]][crates.io]
+
+[Build Status]: https://img.shields.io/github/actions/workflow/status/pollen-robotics/motor_toolbox_rs/rust.yml?branch=master
+[actions]: https://github.com/pollen-robotics/motor_toolbox_rs/actions?query=branch%3Amaster
+
+[Latest Version]: https://img.shields.io/crates/v/motor_toolbox_rs.svg
+[crates.io]: https://crates.io/crates/motor_toolbox_rs
+
+## Overview
+
+Simple toolbox that proposes:
+* a motor abstraction (single or multiple motors) - useful to allow to switch between different motor communication types (e.g. serial, CAN, etc.)
+* basic fake motors functionalities mostly for testing purposes
+
+
+## Documentation
+
+See https://docs.rs/motor_toolbox_rs for more information on APIs and examples.
+
+## License
+
+This library is licensed under the [Apache License 2.0](./LICENSE).
+
+## Support
+
+Rustypot is developed and maintained by [Pollen-Robotics](https://pollen-robotics.com). They developped open-source tools for robotics manipulation.
+Visit https://pollen-robotics.com to learn more or join the [Dicord community](https://discord.com/invite/Kg3mZHTKgs) if you have any questions or want to share your projects.