Skip to content

update readme #57

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

Merged
yanganto merged 5 commits into from
Dec 4, 2025
Merged

update readme #57

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7e60eb3
update readme
yanganto Dec 4, 2025
76e266c
Update README.md
yanganto Dec 4, 2025
20af085
Update README.md
yanganto Dec 4, 2025
b6250f9
Update README.md
yanganto Dec 4, 2025
06d4c4d
Update README.md
yanganto Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,15 @@ c = "third"

```

## Why TOML is good for program configuration file
There are several common config file solutions: INI, JSON, YAML, TOML.
- INI is legacy and no nesting support, and the comment char is not designed at first, so some parser will use `;` or `#`.
- JSON does not support documentation. It is efficient for data exchange, but configuration files should include documentation, so it is not good for this use case.
- YAML is too greedy on covering derserialize issue, so it is too complex for a configuration and vulnerable, for example:
- `y` ambiguously stand for "y" or true
- [CVE-2019-11253](https://github.com/kubernetes/kubernetes/issues/83253)
- TOML is good for now, and easy to write and read for human, that is a real need for configuration file.

[crates-badge]: https://img.shields.io/crates/v/toml-example.svg
[crate-url]: https://crates.io/crates/toml-example
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
Expand Down