toml-rs/README.md

# toml-rs

[![Build Status](https://travis-ci.com/alexcrichton/toml-rs.svg?branch=master)](https://travis-ci.com/alexcrichton/toml-rs)
[![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)
[![Documentation](https://docs.rs/toml/badge.svg)](https://docs.rs/toml)

A [TOML][toml] decoder and encoder for Rust. This library is currently compliant
with the v0.5.0 version of TOML. This library will also likely continue to stay
up to date with the TOML specification as changes happen.

[toml]: https://github.com/toml-lang/toml

```toml
# Cargo.toml
[dependencies]
toml = "0.4"
```

This crate also supports serialization/deserialization through the
[serde](https://serde.rs) crate on crates.io. Currently the older `rustc-serialize`
crate is not supported in the 0.3+ series of the `toml` crate, but 0.2 can be
used for that support.

# License

This project is licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
   http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
   http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in toml-rs by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
Put documentation on github 2014-08-03 23:30:30 -05:00			`# toml-rs`

Update build urls 2019-01-02 16:15:57 -06:00			`[![Build Status](https://travis-ci.com/alexcrichton/toml-rs.svg?branch=master)](https://travis-ci.com/alexcrichton/toml-rs)`
Add coverage badge 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)`
Add a latest version shield to the readme 2017-01-27 19:04:31 -06:00			`[![Latest Version](https://img.shields.io/crates/v/toml.svg)](https://crates.io/crates/toml)`
Add a beautiful badge for docs.rs 2017-04-05 13:17:24 -05:00			`[![Documentation](https://docs.rs/toml/badge.svg)](https://docs.rs/toml)`
Put documentation on github 2014-08-03 23:30:30 -05:00
Update metadata 2017-02-08 23:27:28 -06:00			`A [TOML][toml] decoder and encoder for Rust. This library is currently compliant`
Indicate this is now supporting version 0.5 of TOML. 2018-11-21 11:41:57 -06:00			`with the v0.5.0 version of TOML. This library will also likely continue to stay`
Update metadata 2017-02-08 23:27:28 -06:00			`up to date with the TOML specification as changes happen.`
Put documentation on github 2014-08-03 23:30:30 -05:00
Linkify TOML in README 2015-02-13 20:21:50 -06:00			`[toml]: https://github.com/toml-lang/toml`

Put documentation on github 2014-08-03 23:30:30 -05:00			```toml
			`# Cargo.toml`
Update Cargo.toml syntax 2015-02-03 00:55:50 -06:00			`[dependencies]`
Update doc urls to 0.4 Closes #168 2017-05-02 11:19:40 -05:00			`toml = "0.4"`
Put documentation on github 2014-08-03 23:30:30 -05:00			```

Update metadata 2017-02-08 23:27:28 -06:00			`This crate also supports serialization/deserialization through the`
Fix serde.rs link in README.md 2017-02-12 20:00:47 -06:00			[serde](https://serde.rs) crate on crates.io. Currently the older `rustc-serialize`
Update metadata 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.`
Clarify that serde is supported Closes #122 2017-01-09 19:37:05 -06:00
Add a dual MIT/Apache license 2014-09-03 13:20:27 -05:00			`# License`

Clarify wording of license information in README. This text historically was copied verbatim from rust-lang/rust's own README [1] with the intention of licensing projects the same as rustc's own license, namely a dual MIT/Apache-2.0 license. The clause about "various BSD-like licenses" isn't actually correct for almost all projects other than rust-lang/rust and the wording around "both" was slightly ambiguous. This commit updates the wording to match more precisely what's in the standard library [2], namely clarifying that there aren't any BSD-like licenses in this repository and that the source is licensable under either license, at your own discretion. [1]: https://github.com/rust-lang/rust/tree/f0fe716dbcbf2363ab8f929325d32a17e51039d0#license [2]: https://github.com/rust-lang/rust/blob/f0fe716dbcbf2363ab8f929325d32a17e51039d0/src/libstd/lib.rs#L5-L9 2017-10-30 16:50:58 -05:00			`This project is licensed under either of`
Add a dual MIT/Apache license 2014-09-03 13:20:27 -05:00
Clarify wording of license information in README. This text historically was copied verbatim from rust-lang/rust's own README [1] with the intention of licensing projects the same as rustc's own license, namely a dual MIT/Apache-2.0 license. The clause about "various BSD-like licenses" isn't actually correct for almost all projects other than rust-lang/rust and the wording around "both" was slightly ambiguous. This commit updates the wording to match more precisely what's in the standard library [2], namely clarifying that there aren't any BSD-like licenses in this repository and that the source is licensable under either license, at your own discretion. [1]: https://github.com/rust-lang/rust/tree/f0fe716dbcbf2363ab8f929325d32a17e51039d0#license [2]: https://github.com/rust-lang/rust/blob/f0fe716dbcbf2363ab8f929325d32a17e51039d0/src/libstd/lib.rs#L5-L9 2017-10-30 16:50:58 -05:00			`* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or`
			`http://www.apache.org/licenses/LICENSE-2.0)`
			`* MIT license ([LICENSE-MIT](LICENSE-MIT) or`
			`http://opensource.org/licenses/MIT)`

			`at your option.`

			`### Contribution`

			`Unless you explicitly state otherwise, any contribution intentionally submitted`
Serde -> toml-rs 2017-12-02 07:22:52 -06:00			`for inclusion in toml-rs by you, as defined in the Apache-2.0 license, shall be`
Clarify wording of license information in README. This text historically was copied verbatim from rust-lang/rust's own README [1] with the intention of licensing projects the same as rustc's own license, namely a dual MIT/Apache-2.0 license. The clause about "various BSD-like licenses" isn't actually correct for almost all projects other than rust-lang/rust and the wording around "both" was slightly ambiguous. This commit updates the wording to match more precisely what's in the standard library [2], namely clarifying that there aren't any BSD-like licenses in this repository and that the source is licensable under either license, at your own discretion. [1]: https://github.com/rust-lang/rust/tree/f0fe716dbcbf2363ab8f929325d32a17e51039d0#license [2]: https://github.com/rust-lang/rust/blob/f0fe716dbcbf2363ab8f929325d32a17e51039d0/src/libstd/lib.rs#L5-L9 2017-10-30 16:50:58 -05:00			`dual licensed as above, without any additional terms or conditions.`