Skip to content

Commit aa51e15

Browse files
committed
updated readme
1 parent 5beb95f commit aa51e15

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

ReadMe.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# ArduinoYaml
1+
# ArduinoYaml A.K.A YAMLDuino
22

3-
This library is based on [libyaml](https://github.com/yaml/libyaml).
4-
It provides two ways to convert YAML strings to JSON (cJSON or ArduinoJson) objects.
3+
This arduino library is based on [libyaml](https://github.com/yaml/libyaml).
4+
5+
It provides several ways to serialize/deserialize YAML<=>JSON using cJSON or ArduinoJson objects.
56

67
Supported platforms (some untested):
78

@@ -23,7 +24,7 @@ Supported platforms (some untested):
2324
size_t serializeYml( cJSON* src_obj, String &dest_string );
2425
// cJSON object to YAML stream
2526
size_t serializeYml( cJSON* src_obj, Stream &dest_stream );
26-
// JSON stream to cJSON object to YAML stream
27+
// JSON stream to cJSON object to YAML stream, disabled on some architectures
2728
size_t serializeYml( Stream &json_src_stream, Stream &yml_dest_stream );
2829

2930
// YAML string to cJSON object
@@ -44,7 +45,7 @@ Supported platforms (some untested):
4445
size_t serializeYml( JsonVariant src_obj, String &dest_string );
4546
// ArduinoJSON object to YAML stream
4647
size_t serializeYml( JsonVariant src_obj, Stream &dest_stream );
47-
// JSON stream to JsonObject to YAML stream
48+
// JSON stream to JsonObject to YAML stream, disabled on some architectures
4849
size_t serializeYml( Stream &json_src_stream, Stream &yml_dest_stream );
4950
// Deserialize YAML string to ArduinoJSON object
5051
DeserializationError deserializeYml( JsonObject &dest_obj, const char* src_yaml_str );

0 commit comments

Comments
 (0)