https://github.com/kortirso/yml
Elixir package for reading/writing yml/yaml files
https://github.com/kortirso/yml
elixir elixir-library parser yaml yml
Last synced: about 2 months ago
JSON representation
Elixir package for reading/writing yml/yaml files
- Host: GitHub
- URL: https://github.com/kortirso/yml
- Owner: kortirso
- Created: 2018-12-19T20:36:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-23T19:14:35.000Z (over 7 years ago)
- Last Synced: 2025-10-07T01:22:39.847Z (9 months ago)
- Topics: elixir, elixir-library, parser, yaml, yml
- Language: Elixir
- Size: 9.77 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Yml
Elixir package for reading/writing yml/yaml files.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `yml` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:yml, "~> 0.9.1"}
]
end
```
## Using
### Read from YML file
Read from YML/YAML file
```elixir
Yml.read_from_file("/path_to_file")
```
### Write to string
Read from YML/YAML file
```elixir
Yml.write_to_string(content)
```
### Write to YML file
Read from YML/YAML file
```elixir
Yml.write_to_file("/path_to_file", content)
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/kortirso/yml.
## License
The package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Disclaimer
Use this package at your own peril and risk.
## Documentation
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/learn_kit](https://hexdocs.pm/learn_kit).