Skip to content

Commit e12203e

Browse files
authored
Merge pull request #18 from bringauto/readme_update_img
Readme - update img and TYPO changes
2 parents df3760a + 817a864 commit e12203e

4 files changed

Lines changed: 51 additions & 6 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Fleet Protocol
22

3-
Fleet Protocol is a communication technology developed by BringAuto to allow for **simple and reliable** communication between
3+
**Connect any device from anywhere to everywhere!**
4+
5+
![Fleet Protocol](./doc/img/FleetProtocolImg.webp)
6+
7+
## General
8+
9+
Fleet Protocol is a **modular** communication technology developed by BringAuto to allow for **simple and reliable** communication between
410
devices deployed in an **internet-connection-unstable** environment and cloud infrastructure.
511

612
Protocol consists of three parts:
@@ -14,14 +20,13 @@ Protocol consists of three parts:
1420

1521
## Communication protocol
1622

17-
We use the [ProtoBuf] library for message format (version [Protobuf version]) and serialization/deserialization - protocol
18-
specification
19-
can be found in protobuf folder.
23+
[ProtoBuf] (see [Protobuf version]) is used to serialize and deserialize messages. The message format
24+
specification can be found in the protobuf folder.
2025

2126
Each message must be prefixed with a four bytes long (uint32_t data type) header, which holds
22-
information about the size of the ProtoBuf message.
27+
information about the size of the Protobuf message.
2328

24-
To read more about the system architecture, check the Fleet Protocol v2 documentation:
29+
Check the Fleet Protocol v2 documentation to learn more about the system architecture:
2530

2631
- [Summary] - overall high-level summary
2732
- [Fleet Protocol Requirements]
@@ -73,6 +78,9 @@ Optional fields have defaults as described in the [ProtoBuf] v3 doc.
7378

7479
## Repo structure
7580

81+
This repository contains a basic C API and CMake project to easily
82+
implement Fleet Protocol Modules.
83+
7684
### Examples
7785

7886
Samples of fleet-protocol features usage.

0 commit comments

Comments
 (0)