Arbit - project tracking

PHPillow - PHP CouchDB connector

Browse source code

File: / README

Type
application/octet-stream application/octet-stream
Last Author
kore
Version
104
Line Rev. Author Source
1 19 kore ================
2 ↓ kore PHPillow read me
3 ↓ kore ================
4 ↓ kore
5 ↓ kore PHPillow is an object orientated wrapper for CouchDB__.
6 ↓ kore
7 ↓ kore __ http://couchdb.org/
8 ↓ kore
9 ↓ kore Prerequisites
10 ↓ kore =============
11 ↓ kore
12 37 kore The following prerequisites must be fulfilled to use PHPillow:
13 19 kore
14 37 kore - A running CouchDB installation from current trunk.
15 19 kore
16 101 kore We already adapted the library to the current changes for 0.9, so that it
17 104 kore won't work any more with the old release in version 0.8.1, and older.
18 19 kore
19 104 kore Versions prior to 0.3-alpha worked only with older versions of CouchDB.
20 ↓ kore
21 101 kore - PHP 5.2
22 19 kore
23 101 kore The wrapped has been tested with the latest releases from the PHP 5.2 tree.
24 ↓ kore It might also work with earlier versions of PHP, but this is not supported.
25 ↓ kore Some features might only be available using LSB from PHP 5.3.
26 19 kore
27 104 kore Version prior to 0.3-alpha required PHP 5.3.
28 ↓ kore
29 19 kore State
30 ↓ kore =====
31 ↓ kore
32 ↓ kore The library will stay in an alpha state at least as long as CouchDB is still
33 ↓ kore alpha. We do not know about changes in API or storage mechanisms in CouchDB, so
34 ↓ kore that we can't guarantee that the PHPillow API will stay completely stable, but
35 37 kore we will try to keep backwards compatibility.
36 19 kore
37 ↓ kore License
38 ↓ kore =======
39 ↓ kore
40 37 kore For the license we have chosen the LGPL 3 as a license. This license gives you
41 ↓ kore a lot rights on the source code with limitations we know and have chosen
42 19 kore intentionally.
43 ↓ kore
44 ↓ kore Contributing
45 ↓ kore ============
46 ↓ kore
47 ↓ kore The library has originally been developed as a part of Arbit__, and the commit
48 ↓ kore mails are still going to the same mailinglist_, same for discussions. If you
49 ↓ kore want to contribute to the library please send your patches to the mailinglist_,
50 ↓ kore or ask for commit access on either the mailinglist or IRC_.
51 ↓ kore
52 101 kore __ http://tracker.arbitracker.org/phpillow
53 19 kore
54 ↓ kore Mailinglist
55 ↓ kore -----------
56 ↓ kore
57 ↓ kore The mailinglist for discussion on PHPillow is available at
58 ↓ kore list@arbitracker.org. You may subscribe by sending an email to
59 ↓ kore list-subscribe@arbitracker.org.
60 ↓ kore
61 ↓ kore IRC
62 ↓ kore ---
63 ↓ kore
64 ↓ kore There is an IRC channel, where you may also discuss the library, submit patches
65 ↓ kore or request commit access, which is currently located in the EuIRC__:
66 ↓ kore irc://irc.euirc.net/#arbit
67 ↓ kore
68 ↓ kore __ http://euirc.net
69 ↓ kore
70 ↓ kore Coding and commit standards
71 ↓ kore ---------------------------
72 ↓ kore
73 ↓ kore The coding and commit are the same as for Arbit and are not up to discussion.
74 ↓ kore You can find them under docs/coding_guidelines.txt. Please follow our coding
75 ↓ kore standards when contributing to the library, otherwise your contributions may be
76 ↓ kore rejected because of these plain formal issues.
77 ↓ kore
78 ↓ kore Usage
79 ↓ kore =====
80 ↓ kore
81 ↓ kore There is a tutorial describing the basic usage of the library, which can be
82 ↓ kore found at docs/tutorial.txt and a speed test which is a working script using the
83 ↓ kore wrapper.
84 ↓ kore
85 ↓ kore You may also find example documents and views in the document/ and view/
86 37 kore folders, which you may use as a starting point for you implementations.
87 19 kore

Arbit - project tracking, licensed under GPL 3