SharpYaml icon indicating copy to clipboard operation
SharpYaml copied to clipboard

Usage samples are lacking information

Open csharpsi opened this issue 4 years ago • 1 comments

I'm finding it really hard figuring out how to use this library to deserialize yaml, it would be really useful to have usage examples of deserializing yaml into an object.

I was hoping the API would be similar to Newtonsoft's JSON API, something like:

Yaml.Deserialise<MyType>(someYamlStream)

The best I can see is the Parser class which seems to be quite a low level iterator.

csharpsi avatar Jun 05 '20 23:06 csharpsi

You have plenty of examples in the tests SerializationTests and SerializationTests2.

This project is in low maintenance mode now, so there is no plan to add new APIs. But you can do a PR to add a deserialize example in the readme.

xoofx avatar Jun 06 '20 04:06 xoofx