From e6ec10445f2cb74f7fbbd83c34e3e49ac42ced33 Mon Sep 17 00:00:00 2001 From: Edward Barnard Date: Tue, 22 Dec 2015 13:29:57 +0000 Subject: Add some docs --- README.md | 7 +++++++ src/lib.rs | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 README.md 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; -- cgit v1.2.3