Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Usage samples are lacking information #79

Open
csharpsi opened this issue Jun 5, 2020 · 1 comment
Open

Usage samples are lacking information #79

csharpsi opened this issue Jun 5, 2020 · 1 comment
Labels

Comments

@csharpsi
Copy link

csharpsi commented Jun 5, 2020

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.

@xoofx
Copy link
Owner

xoofx commented Jun 6, 2020

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 xoofx added the question label Jun 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants