diff --git a/README.md b/README.md index b66a38b..c103823 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # micro_ros_msgs -Collection of ROS 2 message definitions used throughout the implementation of micro-ROS, both in the agent and client endpoints. + +## Summary + +Collection of ROS 2 message definitions used throughout the implementation of micro-ROS, both in the server ([micro-ROS Agent](https://github.com/micro-ROS/micro-ROS-Agent/)) and client ([micro-ROS RMW](https://github.com/micro-ROS/rmw-microxrcedds)) endpoints. + +## Purpose of the Project + +This software is not ready for production use. +It has neither been developed nor tested for a specific use case. +However, the license conditions of the applicable Open Source licenses allow you to adapt the software to your needs. +Before using it in a safety relevant setting, make sure that the software fulfills your requirements and adjust it according to any applicable safety standards, e.g., ISO 26262. + +## License + +This repository is open-sourced under the Apache-2.0 license. See the LICENSE file for details. + +## Known Issues/Limitations + +There are no known limitations.