diff options
author | Markus Unterwaditzer <markus@unterwaditzer.net> | 2015-01-15 15:33:48 +0100 |
---|---|---|
committer | Markus Unterwaditzer <markus@unterwaditzer.net> | 2015-01-15 15:33:48 +0100 |
commit | 621db9a0631af50d0ba5eff0b654397e09d0e326 (patch) | |
tree | 5773ceb58ada8e34f08efb59d1e2046847494d76 | |
parent | 24e977e9d9ccee34b89dfbdb7ace386afc27ed2a (diff) |
rewrite readme
-rw-r--r-- | README.md | 16 |
1 files changed, 11 insertions, 5 deletions
@@ -1,12 +1,18 @@ # VObject parser for Rust -**This is an experiment by me to learn Rust, performance and API are bad.** - [![Build Status](https://travis-ci.org/untitaker/rust-vobject.svg?branch=master)](https://travis-ci.org/untitaker/rust-vobject) -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). +This is a parser and writer for the +[vCard](https://tools.ietf.org/html/rfc6350) and +[iCalendar](https://tools.ietf.org/html/rfc5545) formats. + +- It doesn't follow all relevant RFCs, and some fundamental things such as + property encodings are missing. +- The API is still quite unstable. This is an experiment by me to learn Rust. + +Nevertheless, I use it for [a simple addressbook +script](https://github.com/untitaker/mates.rs), and you're encouraged to test +it and give feedback in the issue tracker. Sourcecode is available on [GitHub](https://github.com/untitaker/rust-vobject). The API documentation is [online |