aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEdward Barnard2015-12-22 13:29:57 +0000
committerEdward Barnard2015-12-22 13:30:55 +0000
commite6ec10445f2cb74f7fbbd83c34e3e49ac42ced33 (patch)
tree5e0ca1ff76b9bfdc940b831faeb5d2d58ef0c3c8
parente43f1b99415d9a447dd450581ce303afd17f6354 (diff)
downloadrust-plist-e6ec10445f2cb74f7fbbd83c34e3e49ac42ced33.tar.bz2
Add some docs
-rw-r--r--README.md7
-rw-r--r--src/lib.rs37
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.
+
+[![Build Status](https://travis-ci.org/ebarnard/rust-plist.svg?branch=master)](https://travis-ci.org/ebarnard/rust-plist)
+
+[Documentation](https://ebarnard.github.io/rust-plist/)
diff --git a/src/lib.rs b/src/lib.rs
index 6e5c269..ced596a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -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;