Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amihaiemil committed May 29, 2018
1 parent fb4aa12 commit a870a28
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The API of this library is clean, intuitive and generally close to the ``javax.j

## Features

Since the library is quite young, it doesn't support all the features of YAML yet. For now, it only supports creating/parsing **blobk** YAML, so use it if you have to read/create configuration files and such stuff. It doesn't yet implement features such as **flow** or **recursive** representation or document streams (more YAMLs separated by ``---``).
Since the library is quite young, it doesn't support all the features of YAML yet. For now, it only supports creating/parsing **block** YAML, so use it if you have to read/create configuration files and such stuff. It doesn't yet implement features such as **flow** or **recursive** representation or document streams (more YAMLs separated by ``---``).

However, keep in mind that the library is based on interfaces and OOP best practices, so you can probably extend/decorate the objects in order to create the functionality you need!

Expand All @@ -58,7 +58,7 @@ YamlMapping yaml = Yaml.createYamlMappingBuilder()
).build();
```

``toString()`` methods are overriden to pretty-print the yaml, so the above ``yaml.toString()`` will print (notice that the elements are ordered, according to the Yaml specification):
``toString()`` methods are overriden to pretty-print the yaml, so the above ``yaml.toString()`` will print (also, notice that the elements are ordered, according to the Yaml specification):

```yaml
architect: amihaiemil
Expand Down

0 comments on commit a870a28

Please sign in to comment.