toml-rs/README.md

32 lines
1.2 KiB
Markdown
Raw Normal View History

2014-08-03 23:30:30 -05:00
# toml-rs
[![Build Status](https://travis-ci.org/alexcrichton/toml-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/toml-rs)
2015-07-10 17:10:57 -05:00
[![Coverage Status](https://coveralls.io/repos/alexcrichton/toml-rs/badge.svg?branch=master&service=github)](https://coveralls.io/github/alexcrichton/toml-rs?branch=master)
[![Latest Version](https://img.shields.io/crates/v/toml.svg)](https://crates.io/crates/toml)
2017-04-05 13:17:24 -05:00
[![Documentation](https://docs.rs/toml/badge.svg)](https://docs.rs/toml)
2014-08-03 23:30:30 -05:00
2017-02-08 23:27:28 -06:00
A [TOML][toml] decoder and encoder for Rust. This library is currently compliant
with the v0.4.0 version of TOML. This library will also likely continue to stay
up to date with the TOML specification as changes happen.
2014-08-03 23:30:30 -05:00
2015-02-13 20:21:50 -06:00
[toml]: https://github.com/toml-lang/toml
2014-08-03 23:30:30 -05:00
```toml
# Cargo.toml
2015-02-03 00:55:50 -06:00
[dependencies]
2017-05-02 11:19:40 -05:00
toml = "0.4"
2014-08-03 23:30:30 -05:00
```
2017-02-08 23:27:28 -06:00
This crate also supports serialization/deserialization through the
2017-02-12 20:00:47 -06:00
[serde](https://serde.rs) crate on crates.io. Currently the older `rustc-serialize`
2017-02-08 23:27:28 -06:00
crate is not supported in the 0.3+ series of the `toml` crate, but 0.2 can be
used for that support.
2014-09-03 13:20:27 -05:00
# License
`toml-rs` is primarily distributed under the terms of both the MIT license and
the Apache License (Version 2.0), with portions covered by various BSD-like
licenses.
See LICENSE-APACHE, and LICENSE-MIT for details.