Add example to README

joajfreitas · Sep 13, 2024 · 79e23bb · 79e23bb
1 parent 90bef03
commit 79e23bb
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,12 +2,32 @@
 
 # FST Communication Protocol
 
-Interface description language with a focus on communication protocols.
+FCP is an interface description language to exchange information independently of language and platform.
 
 ## Install
 
 	$ pip install fcp
 
+## Example
+
+```
+version: "3"
+
+use temperature::Temperature;
+
+/*this is a comment*/
+enum SensorState {
+        Off;
+        On;
+        Error;
+};
+
+struct SensorInformation {
+    temperature @ 0: Temperature;
+    sensor_state @ 1: SensorState
+};
+```
+
 ## Documentation
 
 See [readthedocs.io](https://fcp-core.readthedocs.io/en/latest/)

diff --git a/example/example.fcp b/example/example.fcp
@@ -11,5 +11,5 @@ enum SensorState {
 
 struct SensorInformation {
     temperature @ 0: Temperature;
-    sensor_state @ 1: SensorState
+    sensor_state @ 1: SensorState;
 };