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.

Sign up for GitHub

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

Jump to bottom

Minor readme adjustments #273

Merged
merged 1 commit into from Mar 13, 2024
Merged

Minor readme adjustments #273

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Expand Up @@ -2,18 +2,18 @@

![Example](./docs/_assets/Scala_YAML_red.svg)

Scala Yaml is written in Scala, dependency-free library that allows to work with the [YAML](https://yaml.org/spec/1.2.2/).
Scala Yaml is a dependency-free Scala library that allows you to work with [YAML](https://yaml.org/spec/1.2.2/).

The goal of this project is to create idiomatic library which:
The goal of this project is to create an idiomatic library which:
* provides compile time type safety
* semiautomatically derives codecs instances
* have explicit error handling and helpful error messages
* semiautomatically derives codec instances
* has explicit error handling and helpful error messages
* cross compiles to [Scala.js](http://www.scala-js.org/) and [Scala Native](https://github.com/scala-native/scala-native) (waiting for Scala 3 support in SN)

Please see the [guide](https://virtuslab.github.io/scala-yaml/docs/) for more information

# Help us create our roadmap!
Take part in our [discussions](https://github.com/VirtusLab/scala-yaml/discussions), post your ideas, vote for feature requests and have a real impact on how our next milestone will look like!
Take part in our [discussions](https://github.com/VirtusLab/scala-yaml/discussions), post your ideas, vote for feature requests, and have a real impact on how our next milestone will look like!

# Usage

Expand Down