toml-rs/README.md

59 lines
1.7 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)
2014-08-03 23:30:30 -05:00
2015-04-08 10:01:49 -05:00
[Documentation](http://alexcrichton.com/toml-rs)
2014-08-03 23:30:30 -05:00
2015-02-13 20:21:50 -06:00
A [TOML][toml] decoder and encoder for Rust. This library is currently compliant with
2015-02-13 20:18:36 -06:00
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]
2016-08-16 15:39:14 -05:00
toml = "0.2"
2014-08-03 23:30:30 -05:00
```
By default this crate supports [`rustc-serialize`] style serialization. This can
be disabled though by disabling the default feature set:
[`rustc-serialize`]: http://github.com/rust-lang/rustc-serialize
```toml
# Cargo.toml
[dependencies]
toml = { version = "0.2", default-features = false }
```
If you'd like to enable support for [serde] you can enable the `serde` feature:
[serde]: https://github.com/serde-rs/serde
```toml
# Cargo.toml
[dependencies]
toml = { version = "0.2", features = ["serde"] }
```
If you'd like to *only* support serde, you can also write:
[serde]: https://github.com/serde-rs/serde
```toml
# Cargo.toml
[dependencies]
toml = { version = "0.2", features = ["serde"], default-features = false }
```
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.