summaryrefslogtreecommitdiffstats
path: root/README.md
blob: ee91d33dd909a6dbc7fc424af56047020c41e286 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# VObject parser and generator for Rust

[![Build Status](https://travis-ci.org/untitaker/rust-vobject.svg?branch=master)](https://travis-ci.org/untitaker/rust-vobject)

This is a parser and generator 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.
- Consequently, the API is still unstable, and it's hard to predict how it
  would have to change if new RFCs are implemented.

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
available](http://rust-vobject.unterwaditzer.net), or you can build it
yourself:

    make docs

The testsuite can be run with:

    make test


It is licensed under MIT, see `LICENSE`.