Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mazurel authored Nov 16, 2024
1 parent 3df2c95 commit 17f7634
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
<h1>Modbus library for modern C++</h1>

Library for high level Modbus frame manipulation, including encoding and decoding, written in modern C++17.
[![CMake on multiple platforms](https://github.com/Mazurel/Modbus/actions/workflows/cmake-multi-platform.yml/badge.svg?branch=master)](https://github.com/Mazurel/Modbus/actions/workflows/cmake-multi-platform.yml)
[![Clang formatting checker](https://github.com/Mazurel/Modbus/actions/workflows/clang-format.yml/badge.svg?branch=master)](https://github.com/Mazurel/Modbus/actions/workflows/clang-format.yml)


Library for high level Modbus frame/packet manipulation, including encoding and decoding, all written in modern C++17.

Additionally, library contains reference TCP and RTU implementation (on Linux only !),
that you can use as a starting point for you application !
Until there will some reliable way to test it, it will be treated as such.

<details>

<summary>More informations for Windows users</summary>

If you are interested in Windows RTU implementation, you can look at to pull request: https://github.com/Mazurel/Modbus/pull/5 .
I am currently unable to merge it, as I do not have required hardware for testing.

</details>


# Table of content
- [Why](#why)
- [Important Concept](#important-concept)
Expand Down

0 comments on commit 17f7634

Please sign in to comment.