diff options
author | Markus Unterwaditzer <markus@unterwaditzer.net> | 2014-11-14 12:48:48 +0100 |
---|---|---|
committer | Markus Unterwaditzer <markus@unterwaditzer.net> | 2014-11-14 12:48:48 +0100 |
commit | 7fc2d49204f25c8e4daee57514d64a4f3e415ca0 (patch) | |
tree | 35bc545ce825b8a79b3038fd7932404ffffcd404 | |
parent | fd3366552a71db08c981e86e65d8a9a0d1c0d14a (diff) |
update readme
-rw-r--r-- | README.md | 20 |
1 files changed, 12 insertions, 8 deletions
@@ -2,14 +2,18 @@ [![Build Status](https://travis-ci.org/untitaker/rust-vobject.svg?branch=master)](https://travis-ci.org/untitaker/rust-vobject) -This is a primitive unstable vobject parser for Rust, originally written for [a -simple addressbook script](https://github.com/untitaker/mates.rs) and based on -[rust-peg](https://github.com/kevinmehall/rust-peg). +This is a primitive VObject and iCalendar parser for Rust, originally written +for [a simple addressbook script](https://github.com/untitaker/mates.rs) and +based on [rust-peg](https://github.com/kevinmehall/rust-peg). -The author hasn't read the relevant RFCs, so this library handles all versions -of VCard and iCalendar equally badly. +## Documentation -See the testsuite for some basic usage. This is an experiment by me to learn -Rust, and the API is too imperfect to be documented. Suggestions are welcome. + make docs -It is licensed under the MIT license, see `LICENSE`. +## Testsuite + + make test + +This is an experiment by me to learn Rust, and the API is pretty bad. + +It is licensed under MIT, see `LICENSE`. |