README.md from GuilhermeStracini/POC-dotnet-yaml-handling

README.md
Summary

Maintainability

Test Coverage

Issues
# PoC .NET - Handling YAML

[![wakatime](https://wakatime.com/badge/github/GuilhermeStracini/POC-dotnet-yaml-handling.svg)](https://wakatime.com/badge/github/GuilhermeStracini/POC-dotnet-yaml-handling)
[![Maintainability](https://api.codeclimate.com/v1/badges/d86109384fae4b57bcf4/maintainability)](https://codeclimate.com/github/GuilhermeStracini/POC-dotnet-yaml-handling/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/d86109384fae4b57bcf4/test_coverage)](https://codeclimate.com/github/GuilhermeStracini/POC-dotnet-yaml-handling/test_coverage)
[![CodeFactor](https://www.codefactor.io/repository/github/GuilhermeStracini/POC-dotnet-yaml-handling/badge)](https://www.codefactor.io/repository/github/GuilhermeStracini/POC-dotnet-yaml-handling)
[![GitHub license](https://img.shields.io/github/license/GuilhermeStracini/POC-dotnet-yaml-handling)](https://github.com/GuilhermeStracini/POC-dotnet-yaml-handling)
[![GitHub last commit](https://img.shields.io/github/last-commit/GuilhermeStracini/POC-dotnet-yaml-handling)](https://github.com/GuilhermeStracini/POC-dotnet-yaml-handling)
[![Build](https://github.com/GuilhermeStracini/POC-dotnet-yaml-handling/actions/workflows/build.yml/badge.svg)](https://github.com/GuilhermeStracini/POC-dotnet-yaml-handling/actions/workflows/build.yml)
[![Linting](https://github.com/GuilhermeStracini/POC-dotnet-yaml-handling/actions/workflows/linter.yml/badge.svg)](https://github.com/GuilhermeStracini/POC-dotnet-yaml-handling/actions/workflows/linter.yml)

🔬 Proof of Concept of handling YML format (write/read/manipulating) using some C# libraries.

---

## Useful links

- https://yaml.org/spec/
- https://ruudvanasseldonk.com/2023/01/11/the-yaml-document-from-hell
- https://www.luisllamas.es/en/yamldotnet/
- https://learnxinyminutes.com/docs/yaml
- https://medium.com/medialesson/handle-yaml-files-with-net-fe92ce94cf94

---

## YAML Handling

We have integrated the `YamlDotNet` and `SharpYaml` libraries for YAML parsing and serialization.

### Example Usage
Refer to the example in `Src/POCTemplate/Program.cs` for a basic demonstration.

## Libraries

- [YamlDotNet](https://github.com/aaubry/YamlDotNet)
- [SharpYaml](https://github.com/xoofx/SharpYaml)

## Results

### ❓ YamlDotNet

Add results or findings related to the YamlDotNet library here.

### ❓ SharpYaml

Add results or findings related to the SharpYaml library here.