Author: rick
Date: 2010-03-16 16:38:15 +0100 (Tue, 16 Mar 2010)
New Revision: 28566
Modified:
plugins/sfCouchPlugin/trunk/README
plugins/sfCouchPlugin/trunk/package.xml
Log:
Updated the readme
Modified: plugins/sfCouchPlugin/trunk/README
===================================================================
--- plugins/sfCouchPlugin/trunk/README 2010-03-16 15:29:56 UTC (rev 28565)
+++ plugins/sfCouchPlugin/trunk/README 2010-03-16 15:38:15 UTC (rev 28566)
@@ -1,13 +1,13 @@
sfCouchPlugin
=============
-The sfCouch plugin connect symfony to the CouchDB key-value store.
+The sfCouch plugin connects symfony to the CouchDB key-value store.
Installation
------------
To install the plugin for a symfony project, the usual process is to use the
symfony command line.
-You habe to add the alpha option as long as it's not stable.
+You have to add the alpha option as long as this plugin not stable.
$ symfony plugin:install -s alpha sfCouchPlugin
@@ -46,8 +46,8 @@
$newDoc = new sfCouchDocument('mySuperId');
-If the document with this ID exists, it's fetched from the CouchDB and the
property
-newDocument is set to false. That's the way to get a single document by ID
from the db.
+If a document with this ID exists, it's fetched from the CouchDB and the
property
+newDoc->newDocument is set to false. That's the way to get a single document
by ID from the db.
Files can be attached to a document with:
@@ -60,10 +60,10 @@
$tempFilePath = $newDoc->getFile($fileName);
-The file will be put in the webservers temp folder and you get the path of the
+The file will be put in the webservers temp folder and the method returns the
path of the
temp file.
-If you want to habe some more specialized documents just create a new model
class that
+If you want to have some more specialized documents just create a new model
class that
inherits sfCouchDocument.
class mySpecialDocument extends sfCouchDocument
@@ -78,9 +78,10 @@
Views
-----
-To create a mapping just put a javascript file in the folder /config/CouchDB
+To create a view just put a javascript file in the folder /config/CouchDB
that is named VIEWNAME_map.js. If you also need a reduce function create
another
-file named named VIEWNAME_reduce.js.
+file named named VIEWNAME_reduce.js. There's a very simple example
'all_map.js' in
+the distribution.
Note: In production env the views don't get updated automatically. If you
change a
javascript you have to call the task couch:refreshViews.
Modified: plugins/sfCouchPlugin/trunk/package.xml
===================================================================
--- plugins/sfCouchPlugin/trunk/package.xml 2010-03-16 15:29:56 UTC (rev
28565)
+++ plugins/sfCouchPlugin/trunk/package.xml 2010-03-16 15:38:15 UTC (rev
28566)
@@ -13,7 +13,7 @@
<date>2010-03-16</date>
<time>12:00:00</time>
<version>
- <release>0.0.7</release>
+ <release>0.0.8</release>
<api>1.0.0</api>
</version>
<stability>
@@ -58,7 +58,7 @@
<changelog>
<release>
<version>
- <release>0.0.7</release>
+ <release>0.0.8</release>
<api>1.0.0</api>
</version>
<stability>
--
You received this message because you are subscribed to the Google Groups
"symfony SVN" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/symfony-svn?hl=en.
