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 2f784ac commit fb4aa12
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ or download the <a href="https://oss.sonatype.org/service/local/repositories/rel

The API of this library is clean, intuitive and generally close to the ``javax.json`` API that most developers are used to:

## 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 ``---``).

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!

If you have some time and like the library, please consider contributing.

## Building and printing Yaml:

```java
Expand Down

0 comments on commit fb4aa12

Please sign in to comment.