diff options
| -rw-r--r-- | README.md | 7 | ||||
| -rw-r--r-- | src/lib.rs | 37 |
2 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ce69023 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# Plist + +A rusty plist parser. Very much a work in progress. + +[](https://travis-ci.org/ebarnard/rust-plist) + +[Documentation](https://ebarnard.github.io/rust-plist/) @@ -1,3 +1,40 @@ +//! # Plist +//! +//! A rusty plist parser. +//! +//! ## Usage +//! +//! Put this in your `Cargo.toml`: +//! +//! ```toml +//! [dependencies] +//! plist = "0.0.11" +//! ``` +//! +//! And put this in your crate root: +//! +//! ```rust +//! extern crate plist; +//! ``` +//! +//! ## Examples +//! +//! ```rust ignore +//! use plist::Plist; +//! use std::fs::File; +//! +//! let file = File::open("tests/data/xml.plist").unwrap(); +//! let plist = Plist::read(file).unwrap(); +//! +//! match plist { +//! Plist::Array(array) => (), +//! _ => () +//! } +//! +//! ``` +//! +//! + extern crate byteorder; extern crate chrono; extern crate rustc_serialize; |