From 72178879092cf8bb9b6ffca23fdf877171dcf004 Mon Sep 17 00:00:00 2001 From: Pierre Rouanet Date: Fri, 18 Aug 2023 19:31:49 +0200 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d3ab58..56e8d66 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# motor_toolbox_rs \ No newline at end of file +# 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.