diff options
| author | Edward Barnard | 2015-12-22 13:29:57 +0000 | 
|---|---|---|
| committer | Edward Barnard | 2015-12-22 13:30:55 +0000 | 
| commit | e6ec10445f2cb74f7fbbd83c34e3e49ac42ced33 (patch) | |
| tree | 5e0ca1ff76b9bfdc940b831faeb5d2d58ef0c3c8 /src | |
| parent | e43f1b99415d9a447dd450581ce303afd17f6354 (diff) | |
| download | rust-plist-e6ec10445f2cb74f7fbbd83c34e3e49ac42ced33.tar.bz2 | |
Add some docs
Diffstat (limited to 'src')
| -rw-r--r-- | src/lib.rs | 37 | 
1 files changed, 37 insertions, 0 deletions
@@ -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;  | 
