annotate vendor/sabre/vobject/README.md @ 38:ac106d4c8961 default tip

flip /etc/roundcube to point here
author Charlie Root
date Sat, 29 Dec 2018 05:39:53 -0500
parents 430dbd5346f7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
1 sabre/vobject
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
2 =============
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
3
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
4 The VObject library allows you to easily parse and manipulate [iCalendar](https://tools.ietf.org/html/rfc5545)
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
5 and [vCard](https://tools.ietf.org/html/rfc6350) objects using PHP.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
6
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
7 The goal of the VObject library is to create a very complete library, with an easy to use API.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
8
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
9 Build status
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
10 ------------
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
11
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
12 | branch | status |
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
13 | ------ | ------ |
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
14 | master | [![Build Status](https://travis-ci.org/fruux/sabre-vobject.png?branch=master)](https://travis-ci.org/fruux/sabre-vobject) |
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
15 | 3.3 | [![Build Status](https://travis-ci.org/fruux/sabre-vobject.png?branch=3.3)](https://travis-ci.org/fruux/sabre-vobject) |
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
16 | 3.1 | [![Build Status](https://travis-ci.org/fruux/sabre-vobject.png?branch=3.1)](https://travis-ci.org/fruux/sabre-vobject) |
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
17 | 2.1 | [![Build Status](https://travis-ci.org/fruux/sabre-vobject.png?branch=2.1)](https://travis-ci.org/fruux/sabre-vobject) |
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
18 | 2.0 | [![Build Status](https://travis-ci.org/fruux/sabre-vobject.png?branch=2.0)](https://travis-ci.org/fruux/sabre-vobject) |
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
19
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
20
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
21 Installation
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
22 ------------
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
23
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
24 VObject requires PHP 5.3, and should be installed using composer.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
25 The general composer instructions can be found on the [composer website](http://getcomposer.org/doc/00-intro.md composer website).
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
26
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
27 After that, just declare the vobject dependency as follows:
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
28
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
29 "require" : {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
30 "sabre/vobject" : "~3.3"
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
31 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
32
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
33 Then, run `composer.phar update` and you should be good.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
34
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
35 Usage
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
36 -----
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
37
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
38 * [3.x documentation](http://sabre.io/vobject/usage/)
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
39 * [2.x documentation](http://sabre.io/vobject/usage_2/)
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
40 * [Migrating from 2.x to 3.x](http://sabre.io/vobject/upgrade/)
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
41
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
42 Support
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
43 -------
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
44
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
45 Head over to the [SabreDAV mailing list](http://groups.google.com/group/sabredav-discuss) for any questions.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
46
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
47 Made at fruux
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
48 -------------
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
49
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
50 This library is being developed by [fruux](https://fruux.com/). Drop us a line for commercial services or enterprise support.